Update gitignore and readme

pshima · Jan 28, 2016 · b490011 · b490011
1 parent 600f5c1
commit b490011
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -29,3 +29,4 @@ _testmain.go
 /coverage.html
 
 /consul-snapshot
+/consul-snapshot_*
diff --git a/README.md b/README.md
@@ -8,6 +8,22 @@ consul-snapshot runs a small http server that can be used for consul health chec
 
 WARNING: consul-snapshot is still in early development use at your own risk.  Do not use this in production.
 
+## Installation
+Grab the binary from [Releases](/releases)
+
+With go get: 
+```
+go get github.com/pshima/consul-snapshot
+```
+
+From source: 
+```
+git clone https://github.com/pshima/consul-snapshot
+cd consul-snapshot
+make
+make install
+```
+
 ## Configuration
 Configuration is done from environment variables.
 - S3BUCKET (the s3 bucket where backups should be delivered)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -29,3 +29,4 @@ _testmain.go
		/coverage.html

		/consul-snapshot
		/consul-snapshot_*