From b807ca84288b7a2d45e263416219d536ffd1b6dc Mon Sep 17 00:00:00 2001 From: typebrook Date: Fri, 15 May 2020 21:00:22 +0800 Subject: Update README --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 1e75b08..7c06381 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,11 @@ # gist - Manage your gist like a pro All your notes, scripts, config files and snippets deserve version control and tagging! -`gist` is a simple bash script for gist management, lite and dependency-free! -Use it to boost your coding workflow. +`gist` is a simple **bash script** for gist management. +It is light and dependency-free! Helps you to boost coding workflow. - [Getting Started](#Getting-Started) +- [Dependencies](#Dependencies) - [Basic Commands](#Basic-Commands) - [Update and clone gists from Github](#Update-and-clone-gists-from-Github) - [List your gists](#List-your-gists) @@ -57,6 +58,17 @@ gist github 3 gist help ``` +## Dependencies +OK...I lied, this script really depends on some very basic dev tools. +- **GNU coreutils** + Used to process text streams. Also, if you are on Mac and use `sed`, `tail` with BSD version, then it is still fine! +- **wget or curl** + Used to making request to `github.com`. +- **git** + Do not tell me you don't have it on your machine... +- **Python** + 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) + ## Basic Commands ### Update and clone gists from Github Run `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`) -- cgit v1.2.3-70-g09d2