Start adding Usage docs to README

Add a section on setting up your `~/.jklrc` file with required variables.
This commit is contained in:
Gabriel Guzman 2017-10-30 14:11:18 -04:00
parent 1458b63287
commit 1c44b282a8

View file

@ -8,7 +8,18 @@ TODO: Describe the installation process
## 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