README update

This commit is contained in:
Stash Dev 2019-07-27 13:11:51 -07:00
parent 485dcadaa6
commit e8397ea9b2
1 changed files with 8 additions and 2 deletions

View File

@ -62,9 +62,15 @@ Join the [Discord server](https://discord.gg/2TsNFKt).
## Install
* [Revive](https://github.com/mgechev/revive) - Configurable linter `go get github.com/mgechev/revive`
* [Revive](https://github.com/mgechev/revive) - Configurable linter
* Go Install: `go get github.com/mgechev/revive`
* [Packr2](https://github.com/gobuffalo/packr/tree/v2.0.2/v2) - Static asset bundler
* Go Install: `go get github.com/gobuffalo/packr/v2/packr2@v2.0.2`
* [Binary Download](https://github.com/gobuffalo/packr/releases)
* [Yarn](https://yarnpkg.com/en/docs/install) - Yarn package manager
NOTE: You may need to run the `go get` commands outside the project directory to avoid modifying the projects module file.
## Environment
### macOS
@ -82,7 +88,7 @@ TODO
## Commands
* `make build` - Builds the binary
* `make build` - Builds the binary (make sure to build the UI as well... see below)
* `make gqlgen` - Regenerate Go GraphQL files
* `make vet` - Run `go vet`
* `make lint` - Run the linter