From e8397ea9b2b470d003bb486a63f77f5eb156bd03 Mon Sep 17 00:00:00 2001 From: Stash Dev Date: Sat, 27 Jul 2019 13:11:51 -0700 Subject: [PATCH] README update --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8b605edd2..3ae39610d 100644 --- a/README.md +++ b/README.md @@ -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