2017-09-25 15:45:01 -04:00
|
|
|
# jkl
|
|
|
|
|
|
|
|
|
|
TODO: Write a project description
|
|
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
|
|
|
|
TODO: Describe the installation process
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
2017-10-30 14:11:18 -04:00
|
|
|
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
|
2017-09-25 15:45:01 -04:00
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
|
|
|
|
1. Fork it!
|
|
|
|
|
2. Create your feature branch: `git checkout -b my-new-feature`
|
|
|
|
|
3. Commit your changes: `git commit -am 'Add some feature'`
|
|
|
|
|
4. Push to the branch: `git push origin my-new-feature`
|
|
|
|
|
5. Submit a pull request :D
|
