Merge pull request #20 from gabeguz/config-docs

Start adding Usage docs to README
This commit is contained in:
Olivier Tremblay 2020-01-20 10:53:37 -05:00 committed by GitHub
commit 493275c780
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -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