From 52a8e891fe8692f64449a8ac3094d194cab177a1 Mon Sep 17 00:00:00 2001 From: Kyle Banks Date: Thu, 23 Mar 2017 22:45:54 -0400 Subject: [PATCH] Update README.md --- README.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 5e09f8d..8500531 100644 --- a/README.md +++ b/README.md @@ -21,13 +21,22 @@ Goggles can be run in a web browser (cross-platform) or as a standalone application (Mac only). -### Stable +### Stable (browser & standalone) Grab the latest release from the [Releases](https://github.com/KyleBanks/goggles/releases) page. -### From Source +### From Source (browser mode) -Regardless, there are a few steps you'll need to take in order to build and run Goggles from source: +``` +$ go get github.com/KyleBanks/goggles/cmd/goggles +$ goggles +``` + +## Contributing + +Contributions to Goggles are very welcome! In order to contribute, either open a new issue for discussion prior to making changes, or comment on an existing ticket indicating that you'd like to take it. + +In order to work on Goggles there are a few steps you'll need to take in order to build and run from source: 1. `go get github.com/KyleBanks/goggles/...` 2. Install [npm](https://www.npmjs.com/) and [Gulp](http://gulpjs.com/), in order to build the front-end assets. @@ -44,10 +53,6 @@ Regardless, there are a few steps you'll need to take in order to build and run **Note:** If you'd like to see Goggles available as a standalone application on additional platforms, I encourage you to help contribute to the [Gallium](https://github.com/alexflint/gallium) project. -## Contributing - -Contributions to Goggles are very welcome! In order to contribute, either open a new issue for discussion prior to making changes, or comment on an existing ticket indicating that you'd like to take it. - ## Author Goggles was developed by [Kyle Banks](https://twitter.com/kylewbanks).