From 0a26fb46aa1d7f84cca1cdc5205464df1b9c1c05 Mon Sep 17 00:00:00 2001 From: typebrook Date: Sat, 11 Apr 2020 23:37:48 +0800 Subject: Update README --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 0a69575..dc3c5d9 100644 --- a/README.md +++ b/README.md @@ -96,10 +96,11 @@ Say you delete gists with command `gist delete ...`, the local gi ## Configuration `gist` stores your configuraion inside `~/.config/gist.conf`, with `=` format for each line. And just do `source ~/.config/gist.conf` at runtime. -This file is created automatically when you use `gist` at the first time, it only allows current user to read and write (permission 600). +`~/.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). 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: ``` bash +# Set key with a given value gist config # Remove current value from a key @@ -157,7 +158,7 @@ Also, if you run `gist ` with `--no-action`, then action would be ignored For example, use `gist config EDITOR code` to use VSCode instead. ### protocol -**[Optional]** Protocol to clone git repo. Default to HTTPS +**[Optional]** Protocol to clone git repo. Default to `HTTPS` valid values are: - https - ssh -- cgit v1.2.3-70-g09d2