Skip to content

Commit

Permalink
Give a more detailed explanation of the config path
Browse files Browse the repository at this point in the history
  • Loading branch information
ldmberman committed Sep 3, 2015
1 parent e816e11 commit 373379b
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ You need to be authenticated with a username and password in order to execute CL

### Set up the configuration file

The program uses a configuration file with the following path: `$HOME/.clc/config.yml`. One is created automatically on the first execution of any command. The file is in YAML format. The following fields count:
The program uses a configuration file located at `$HOME/.clc/config.yml` on Linux/Unix/Mac and `C:\Users\%username%` on Windows. One is created automatically on the first execution of any command. The file is in YAML format. The following fields count:

* `user` and `password`: the credentials used for authentication.
* `defaultformat`: a default output format, either `json`, `table` or `text`.
Expand Down

0 comments on commit 373379b

Please sign in to comment.