From 1c44b282a8abb7f1a7d9d86492a3403648d72120 Mon Sep 17 00:00:00 2001 From: Gabriel Guzman Date: Mon, 30 Oct 2017 14:11:18 -0400 Subject: [PATCH] Start adding Usage docs to README Add a section on setting up your `~/.jklrc` file with required variables. --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) 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