diff --git a/README.md b/README.md index c8adb69..e0cbe07 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,13 @@ boltprint ========= -A quick Go program for printing out BoltDB files \ No newline at end of file +A quick Go program for printing out BoltDB files + +Usage: +boltprint [format] + +If the 'format' option is not provided then a very basic 'tree' will be output +Currently the only format that is supported is json. + +Disabled Feature: +There is an option in the code to generate a test database file, just look at the 'gentest' branch of the parameter test. \ No newline at end of file