Merge pull request #7 from chilts/install-and-usage

Add install and usage info to the README
2016-12-30 07:30:48 -06:00 · 2016-12-30 07:30:48 -06:00 · a3019e1e0a
parent e1430823a8 af8cc1ccc1
commit a3019e1e0a
1 changed files with 20 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -8,3 +8,23 @@ A CLI Browser for BoltDB Files

 ![Image of Main Browser]
 (http://bullercodeworks.com/boltbrowser/ss1.png)
+
+Installing
+----------
+
+Install in the standard way:
+
+```sh
+go get github.com/br0xen/boltbrowser
+```
+
+Then you'll have `boltbrowser` in your path.
+
+Usage
+-----
+
+Just provide a BoltDB filename to be opened as the first argument on the command line:
+
+```sh
+boltbrowser <filename>
+```