Merge pull request #20 from gabeguz/config-docs
Start adding Usage docs to README
This commit is contained in:
commit
493275c780
1 changed files with 12 additions and 1 deletions
13
README.md
13
README.md
|
|
@ -17,7 +17,18 @@ Then, execute the following command from your shell:
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
TODO: Write usage instructions
|
Make sure you create a `~/.jklrc` file in your home directory, it should contain
|
||||||
|
at a minimum:
|
||||||
|
|
||||||
|
```
|
||||||
|
JIRA_ROOT="https://jira.example.com/"
|
||||||
|
JIRA_USER="myusername"
|
||||||
|
JIRA_PASSWORD="mypassword"
|
||||||
|
JIRA_PROJECT="DPK"
|
||||||
|
```
|
||||||
|
Those values are for example only, your setup will be different.
|
||||||
|
|
||||||
|
TODO: Finish writing usage instructions
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue