created readme and docs

README.md

@@ -0,0 +1,64 @@
+# Jira-Search
+
+Table of Contents
+=================
+
+* [Jira-Search](#jira-search)
+   * [About](#about)
+   * [Docs](#docs)
+   * [Installation](#installation)
+   * [Usage](#usage)
+      * [Example Usage](#example-usage)
+
+## About
+
+this is a releatively simple tool for quick searching jira issues via JQL queries and displaying the data in a nice easy to read table
+
+## Docs
+
+ * [jira-search](docs/jira-search.md)                         - Search Jira Issues via jql queries and others from the cli.
+ * [jira-search search](docs/jira-search_search.md)           - Search Jira for issues matching text
+
+## Installation
+
+Download the binary from releases or you can install the program directly via 
+
+```shell
+go install github.com/mr-pmillz/jira-search@latest
+```
+
+create your config.yaml file
+
+```shell
+cp config.yaml.dist config.yaml
+```
+
+## Usage
+
+```shell
+Search Jira Issues via jql queries and others from
+the cli.
+
+Usage:
+  jira-search [command]
+
+Available Commands:
+  completion  Generate the autocompletion script for the specified shell
+  help        Help about any command
+  search      Search Jira for issues matching text
+
+Flags:
+      --config string   config file (default is $HOME/config.yaml)
+  -h, --help            help for jira-search
+
+Use "jira-search [command] --help" for more information about a command.
+```
+
+### Example Usage
+
+Search for all issues assigned to you and in various status types
+
+```shell
+jira-search --config /path/to/your/config.yaml search --jql-raw-search 'assignee = "Babu Bott" AND status in ("Ready for Work", "In Progress")'
+```
+

config.yaml.dist

@@ -0,0 +1,7 @@
+JIRA_HOST: "https://yourcompany.atlassian.net"
+JIRA_USER_EMAIL: "YourEmail"
+JIRA_API_KEY: "YourAPIKey"
+JIRA_ACCOUNT_ID: "YourAccountID"
+JIRA_USERNAME: "YourUsername"
+JIRA_PROJECT_NAME: "" # optional, unused
+

docs/jira-search.md

@@ -18,4 +18,4 @@ the cli.
 
 * [jira-search search](jira-search_search.md)	 - Search Jira for issues matching text
 
-###### Auto generated by spf13/cobra on 22-Apr-2022
+###### Auto generated by spf13/cobra on 4-May-2022

docs/jira-search_search.md

@@ -26,6 +26,7 @@ jira-search search [flags]
       --jql-raw-search string          a string of text that you want to search all issues for
       --jql-text-search string         a string of text that you want to search all issues for
       --my-jira-issues                 find all issues assigned and in progress assigned to JIRA_ACCOUNT_ID from config.yaml
+      --reverse-issues                 reverse found issues in table
 ```
 
 ### Options inherited from parent commands
@@ -38,4 +39,4 @@ jira-search search [flags]
 
 * [jira-search](jira-search.md)	 - Search Jira Issues From the Command Line
 
-###### Auto generated by spf13/cobra on 22-Apr-2022
+###### Auto generated by spf13/cobra on 4-May-2022