Skip to content

Commit

Permalink
documentation touch ups for the two experimental features
Browse files Browse the repository at this point in the history
  • Loading branch information
irobl authored and TheNotary committed Jun 13, 2019
1 parent 9b1896c commit f360287
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,12 @@ After that, you may run `gister sync` to fetch all your gists (created and starr

Warn: `sync` can only fetch up to 10 million gists for you. If you have more than 10 million gists, you need to modify the source of `gister` to lift the limit.

### Configuration

`GISTER_USE_HTTPS`: If you need to use https for some reason, set the env var `GISTER_USE_HTTPS`, but please note this isn't necessarily more secure than ssh, it's just a different option in case your network blocks all traffic other than http/s.

`GISTER_AUTO_COMMIT`: If you'd like the `sync` command to automatically commit any local changes you've made before pulling and pushing to gist.github.com, set the `GISTER_AUTO_COMMIT` env var to anything.

### publish

Whenever you want to publish a gist, just use
Expand Down

0 comments on commit f360287

Please sign in to comment.