Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Steve Coffman <[email protected]>
  • Loading branch information
StevenACoffman committed Aug 22, 2021
1 parent 8cf635d commit 106852a
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 3 deletions.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,22 @@ Shared Flags:
| --config string | config file (default is $HOME/.config/jira) |
| -h, --help | help for jt |

### tips
### Tips
Use "jt [command] --help" for more information about a command.

### installation
### Installation
Homebrew users can do this:
```
brew
brew tap StevenACoffman/jt
brew install jt
```

Go developers with `$HOME/bin` in their `$PATH` can run `mage` if they have [mage](https://magefile.org/) installed.

Alternatively, `go run mage.go` will work even without `mage` installed, but it will still put the binary in `$HOME/bin`.

### Development and Limitations
Currently, the config does not allow overriding the workflow states.

Also, if a user doesn't have a config file, it should help them create one.

10 changes: 10 additions & 0 deletions mage.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
// +build ignore

package main

import (
"os"
"github.com/magefile/mage/mage"
)

func main() { os.Exit(mage.Main()) }

0 comments on commit 106852a

Please sign in to comment.