Skip to content

Commit

Permalink
Update docs some more. [skip ci] (#7)
Browse files Browse the repository at this point in the history
  • Loading branch information
jlucktay authored Jul 12, 2019
1 parent 30eca5c commit 1e57d10
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,14 @@ via goreleaser

Coming soon!

## Configuration

There is a sample JSON file `stack.config.example.json` that should be copied over to your
`$HOME/.config/stack/stack.config.json` directory and populated appropriately.

Filling out this config file will require the generation of two personal access tokens, one from Azure DevOps and one
from GitHub. Links to the appropriate pages on each site are in the example file.

## Usage

`stack` has several subcommands:
Expand All @@ -70,7 +78,7 @@ TODO
## Further implementation ideas

- [Cobra - A Commander for modern Go CLI interactions](https://github.com/spf13/cobra)
- [Viper - Go configuration with fangs](https://github.com/spf13/viper)
- ~~[Viper - Go configuration with fangs](https://github.com/spf13/viper)~~
- [go-github - Go library for accessing the GitHub API](https://github.com/google/go-github)

## Contributing
Expand Down

0 comments on commit 1e57d10

Please sign in to comment.