o5r/jkl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #20 from gabeguz/config-docs

Browse source 
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
1 changed files with 12 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -17,7 +17,18 @@ Then, execute the following command from your shell:
## 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