aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authortypebrook <typebrook@gmail.com>2020-04-08 18:01:04 +0800
committertypebrook <typebrook@gmail.com>2020-04-08 18:01:04 +0800
commit33282927fbd661252f59cd2fd086cb13ab8a41dc (patch)
tree6895a056a3cb00939837c0077a9dd7c7a4ea3e35
parentfd637cd17c11364f39470f4f0d9cd2907306ad9f (diff)
Improve README with wording
-rw-r--r--README.md38
1 files changed, 19 insertions, 19 deletions
diff --git a/README.md b/README.md
index 9071161..8232d6b 100644
--- a/README.md
+++ b/README.md
@@ -14,33 +14,33 @@
14- [Tips](#Tips) 14- [Tips](#Tips)
15 - [Filter gists with pipe](#Filter-gists-with-pipe) 15 - [Filter gists with pipe](#Filter-gists-with-pipe)
16 - [Git Branching](#Git-Branching) 16 - [Git Branching](#Git-Branching)
17 - [Suppress action](#Suppress-action)
18 - [Useful action for gist repo](#Useful-action-for-gist-repo) 17 - [Useful action for gist repo](#Useful-action-for-gist-repo)
18 - [Suppress action](#Suppress-action)
19 - [Suppress hint](#Suppress-hint) 19 - [Suppress hint](#Suppress-hint)
20 20
21## Getting started 21## Getting started
22```bash 22```bash
23# fetch your gists and clone them into ~/gist as git repos 23# Fetch your gists and clone them into ~/gist as git repos
24gist fetch 24gist fetch
25# show the list of your gists 25# List your gists
26gist 26gist
27# create a new gist 27# Create a new gist
28gist new 28gist new
29# create private gist with files 'foo' and 'bar' 29# Create private gist with files 'foo' and 'bar'
30gist new -p foo bar 30gist new -p foo bar
31# get the path and cd to cloned repo with subshell 31# Get the path and cd to cloned repo with subshell
32gist 3 32gist 3
33# push changes in your third gist to the remote repo 33# Push changes in your third gist to the remote repo
34gist push 3 34gist push 3
35# update the description of your third gist 35# Update the description of your third gist
36gist edit 3 36gist edit 3
37# add tags to your third gist 37# Add tags to your third gist
38gist tag 3 38gist tag 3
39# list your gists with tags instead of URL 39# List your gists with tags instead of URL
40gist tag 40gist tag
41# delete gists with indices 3, 4 and 5 41# Delete gists with indices 3, 4 and 5
42gist delete 3 4 5 42gist delete 3 4 5
43# or use Brace Expansion 43# Or use Brace Expansion
44gist delete {3..5} 44gist delete {3..5}
45# Import your third gist as a new Github repo with web page 45# Import your third gist as a new Github repo with web page
46gist github 3 46gist github 3
@@ -180,8 +180,8 @@ gist tag 3
180``` 180```
181After it is finished, `gist` just calls Github API to apply new description onto the given gist. 181After it is finished, `gist` just calls Github API to apply new description onto the given gist.
182 182
183#### Display list with tags 183#### List gists with tags
184Use sub-command `tag` to show the list of gists with tags instead of URLs. 184Use sub-command `tag` to list gists with tags instead of URLs.
185```bash 185```bash
186# show tags for your gists 186# show tags for your gists
187gist tag 187gist tag
@@ -223,8 +223,8 @@ gist grep '^string'
223``` 223```
224 224
225### Filter by file languages 225### Filter by file languages
226#### Display list with languages 226#### List gists with languages
227You can use sub-command `lan` to show the list of gists with file languages instead of URLs. 227You can use sub-command `lan` to List gists with file languages instead of URLs.
228```bash 228```bash
229# show languages for your gists 229# show languages for your gists
230gist lan 230gist lan
@@ -258,9 +258,9 @@ If `STDIN` is from a pipe, then `gist` will only process gists with **indices in
258```bash 258```bash
259# only show gists with index 1 to 20 259# only show gists with index 1 to 20
260seq 20 | gist 260seq 20 | gist
261# Show the list of starred gist with Yaml file 261# List starred gist with Yaml file
262gist star | gist lan Yaml 262gist star | gist lan Yaml
263# Only show the list of gists with tag1, pattern1 in description/filenames/contents and markdown file 263# Only List gists with tag1, pattern1 in description/filenames/contents and markdown file
264gist tag tag1 | gist grep pattern1 | gist lan SHELL 264gist tag tag1 | gist grep pattern1 | gist lan SHELL
265``` 265```
266 266
@@ -288,7 +288,7 @@ gist config action 'true'
288### Suppress hint 288### Suppress hint
289There are several environment variables or arguments can suppress hint or user confirm, like: 289There are several environment variables or arguments can suppress hint or user confirm, like:
290```bash 290```bash
291# show list without hint 291# List gists without hint
292hint=false gist 292hint=false gist
293 293
294# just print the repo path with a given index 294# just print the repo path with a given index