Skip to content

docs: remove unicode zero length characters and fix Markdown to man page conversion #326

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
docs: remove unicode zero length character
  • Loading branch information
lucasrangit committed Sep 15, 2020
commit 1c12774b021cb7a7b25dfda4eed9d137e23f46f0
48 changes: 24 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,74 +8,74 @@ upload content to https://gist.github.com/.

## Installation

If you have ruby installed:
If you have ruby installed:

gem install gist

If you're using Bundler:
If you're using Bundler:

source :rubygems
gem 'gist'

For OS X, gist lives in Homebrew
For OS X, gist lives in Homebrew

brew install gist

For FreeBSD, gist lives in ports
For FreeBSD, gist lives in ports

pkg install gist

<200c>For Ubuntu/Debian
For Ubuntu/Debian

apt install gist

Note: Debian renames the binary to `gist-paste` to avoid a name conflict.

## Command

To upload the contents of `a.rb` just:
To upload the contents of `a.rb` just:

gist a.rb

Upload multiple files:
Upload multiple files:

gist a b c
gist *.rb

By default it reads from STDIN, and you can set a filename with `-f`.
By default it reads from STDIN, and you can set a filename with `-f`.

gist -f test.rb <a.rb

Alternatively, you can just paste from the clipboard:
Alternatively, you can just paste from the clipboard:

gist -P

Use `-p` to make the gist private:
Use `-p` to make the gist private:

gist -p a.rb

Use `-d` to add a description:
Use `-d` to add a description:

gist -d "Random rbx bug" a.rb

You can update existing gists with `-u`:
You can update existing gists with `-u`:

gist -u GIST_ID FILE_NAME
gist -u 42f2c239d2eb57299408 test.txt

If you'd like to copy the resulting URL to your clipboard, use `-c`.
If you'd like to copy the resulting URL to your clipboard, use `-c`.

gist -c <a.rb

If you'd like to copy the resulting embeddable URL to your clipboard, use `-e`.
If you'd like to copy the resulting embeddable URL to your clipboard, use `-e`.

gist -e <a.rb

And you can just ask gist to open a browser window directly with `-o`.
And you can just ask gist to open a browser window directly with `-o`.

gist -o <a.rb

To list (public gists or all gists for authed user) gists for user
To list (public gists or all gists for authed user) gists for user

gist -l : all gists for authed user
gist -l defunkt : list defunkt's public gists
Expand All @@ -85,7 +85,7 @@ To read a gist and print it to STDOUT
gist -r GIST_ID
gist -r 374130

See `gist --help` for more detail.
See `gist --help` for more detail.

## Login

Expand All @@ -104,7 +104,7 @@ This flow allows you to obtain a token by logging into GitHub in the browser and
and enter code: XXXX-XXXX
Success! https://github.com/settings/connections/applications/4f7ec0d4eab38e74384e

The returned access_token is stored in `~/.gist` and used for all future gisting. If you need to you can revoke access from https://github.com/settings/connections/applications/4f7ec0d4eab38e74384e.
The returned `access_token` is stored in `~/.gist` and used for all future gisting. If you need to you can revoke access from https://github.com/settings/connections/applications/4f7ec0d4eab38e74384e.

### The username-password flow

Expand Down Expand Up @@ -148,7 +148,7 @@ Once you've done this and restarted your terminal (or run `source ~/.bashrc`), g
automatically use GitHub Enterprise instead of the public github.com

Your token for GitHub Enterprise will be stored in `.gist.<protocol>.<server.name>[.<port>]` (e.g.
`~/.gist.http.github.internal.example.com` for the GITHUB_URL example above) instead of `~/.gist`.
`~/.gist.http.github.internal.example.com` for the `GITHUB_URL` example above) instead of `~/.gist`.

If you have multiple servers or use Enterprise and public GitHub often, you can work around this by creating scripts
that set the env var and then run `gist`. Keep in mind that to use the public GitHub you must unset the env var. Just
Expand All @@ -165,7 +165,7 @@ Error: Bad credentials

# Library

You can also use Gist as a library from inside your ruby code:
You can also use Gist as a library from inside your ruby code:

Gist.gist("Look.at(:my => 'awesome').code")

Expand All @@ -181,11 +181,11 @@ If you need more advanced features you can also pass:

NOTE: The access_token must have the `gist` scope and may also require the `user:email` scope.

If you want to upload multiple files in the same gist, you can:
If you want to upload multiple files in the same gist, you can:

Gist.multi_gist("a.rb" => "Foo.bar", "a.py" => "Foo.bar")

If you'd rather use gist's builtin access_token, then you can force the user
If you'd rather use gist's builtin access_token, then you can force the user
to obtain one by calling:

Gist.login!
Expand All @@ -195,12 +195,12 @@ in `~/.gist`, where it can later be read by `Gist.gist`

## Configuration

If you'd like `-o` or `-c` to be the default when you use the gist executable, add an
If you'd like `-o` or `-c` to be the default when you use the gist executable, add an
alias to your `~/.bashrc` (or equivalent). For example:

alias gist='gist -c'

If you'd prefer gist to open a different browser, then you can export the BROWSER
If you'd prefer gist to open a different browser, then you can export the BROWSER
environment variable:

export BROWSER=google-chrome
Expand Down