Add install and usage info to the README

This commit is contained in:
Andrew Chilton 2016-12-30 10:38:51 +13:00
parent e1430823a8
commit af8cc1ccc1

View File

@ -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>
```