diff --git a/README.md b/README.md index eb6d017..db8498d 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,18 @@ TODO: Describe the installation process ## 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