aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authortypebrook <typebrook@gmail.com>2020-05-15 21:00:22 +0800
committertypebrook <typebrook@gmail.com>2020-05-15 21:00:22 +0800
commitb807ca84288b7a2d45e263416219d536ffd1b6dc (patch)
tree0d9b8b6478323bc1f6a6ad5db5fff8f2cfab9231
parent2e934ee27cfefeae343a1889306f5c329c80ea4f (diff)
Update README
-rw-r--r--README.md16
1 files changed, 14 insertions, 2 deletions
diff --git a/README.md b/README.md
index 1e75b08..7c06381 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,11 @@
1# gist - Manage your gist like a pro 1# gist - Manage your gist like a pro
2 2
3All your notes, scripts, config files and snippets deserve version control and tagging! 3All your notes, scripts, config files and snippets deserve version control and tagging!
4`gist` is a simple bash script for gist management, lite and dependency-free! 4`gist` is a simple **bash script** for gist management.
5Use it to boost your coding workflow. 5It is light and dependency-free! Helps you to boost coding workflow.
6 6
7- [Getting Started](#Getting-Started) 7- [Getting Started](#Getting-Started)
8- [Dependencies](#Dependencies)
8- [Basic Commands](#Basic-Commands) 9- [Basic Commands](#Basic-Commands)
9 - [Update and clone gists from Github](#Update-and-clone-gists-from-Github) 10 - [Update and clone gists from Github](#Update-and-clone-gists-from-Github)
10 - [List your gists](#List-your-gists) 11 - [List your gists](#List-your-gists)
@@ -57,6 +58,17 @@ gist github 3
57gist help 58gist help
58``` 59```
59 60
61## Dependencies
62OK...I lied, this script really depends on some very basic dev tools.
63- **GNU coreutils**
64 Used to process text streams. Also, if you are on Mac and use `sed`, `tail` with BSD version, then it is still fine!
65- **wget or curl**
66 Used to making request to `github.com`.
67- **git**
68 Do not tell me you don't have it on your machine...
69- **Python**
70 Both 2 and 3 works. It is used to process JSON response from `github.com` and launch default browser.(Only built-in modules are used)
71
60## Basic Commands 72## Basic Commands
61### Update and clone gists from Github 73### Update and clone gists from Github
62Run `gist fetch` to fetch your all gists with Github API and keep short information for each gist in a index file inside a given folder. (default to `~/gist/index`) 74Run `gist fetch` to fetch your all gists with Github API and keep short information for each gist in a index file inside a given folder. (default to `~/gist/index`)