diff options
author | typebrook <typebrook@gmail.com> | 2020-04-11 23:37:48 +0800 |
---|---|---|
committer | typebrook <typebrook@gmail.com> | 2020-04-11 23:37:48 +0800 |
commit | 0a26fb46aa1d7f84cca1cdc5205464df1b9c1c05 (patch) | |
tree | 8672c262036b01d891a91befb4fbd824f62f63a8 | |
parent | 9af58572e7d99edd5f0f178bd789b1d36a8e63c6 (diff) |
Update README
-rw-r--r-- | README.md | 5 |
1 files changed, 3 insertions, 2 deletions
@@ -96,10 +96,11 @@ Say you delete gists with command `gist delete <index-of-gist>...`, the local gi | |||
96 | ## Configuration | 96 | ## Configuration |
97 | `gist` stores your configuraion inside `~/.config/gist.conf`, with `<key>=<value>` format for each line. And just do `source ~/.config/gist.conf` at runtime. | 97 | `gist` stores your configuraion inside `~/.config/gist.conf`, with `<key>=<value>` format for each line. And just do `source ~/.config/gist.conf` at runtime. |
98 | 98 | ||
99 | This file is created automatically when you use `gist` at the first time, it only allows current user to read and write (permission 600). | 99 | `~/.config/gist.conf` is created automatically when you run `gist` at the first time, it only allows current user to read and write (permission 600). |
100 | 100 | ||
101 | Valid keys are [`user`](#user), [`token`](#token), [`folder`](#folder), [`auto_sync`](#auto_sync), [`action`](#action), [`EDITOR`](#EDITOR) and [`protocol`](#protocol). Use the following commands to set value: | 101 | Valid keys are [`user`](#user), [`token`](#token), [`folder`](#folder), [`auto_sync`](#auto_sync), [`action`](#action), [`EDITOR`](#EDITOR) and [`protocol`](#protocol). Use the following commands to set value: |
102 | ``` bash | 102 | ``` bash |
103 | # Set key with a given value | ||
103 | gist config <key> <value> | 104 | gist config <key> <value> |
104 | 105 | ||
105 | # Remove current value from a key | 106 | # Remove current value from a key |
@@ -157,7 +158,7 @@ Also, if you run `gist <INDEX>` with `--no-action`, then action would be ignored | |||
157 | For example, use `gist config EDITOR code` to use VSCode instead. | 158 | For example, use `gist config EDITOR code` to use VSCode instead. |
158 | 159 | ||
159 | ### protocol | 160 | ### protocol |
160 | **[Optional]** Protocol to clone git repo. Default to HTTPS | 161 | **[Optional]** Protocol to clone git repo. Default to `HTTPS` |
161 | valid values are: | 162 | valid values are: |
162 | - https | 163 | - https |
163 | - ssh | 164 | - ssh |