o5r/jkl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
jkl/README.md
Gabriel Guzman 1c44b282a8 Start adding Usage docs to README 
Add a section on setting up your `~/.jklrc` file with required variables.
2017-10-30 14:11:18 -04:00

665 B
Raw Blame History

jkl

TODO: Write a project description

Installation

TODO: Describe the installation process

Usage

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

  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