readme: cleaning

Author: maxlath

README.md

@@ -1,81 +1,116 @@
-# STATUS
+# lev
 
-[![development sponsored by voltra.co](https://img.shields.io/badge/Development%20sponsored%20by-Voltra.co-yellow.svg)](https://voltra.co/)
-
-# SYNOPSIS
 A simple and convenient commandline tool and REPL for [`leveldb`](http://leveldb.org/).
 
-# FEATURES
-- REPL with colorized tab-completion and zsh/fish style key suggestions
-- REPL automatically saves and reloads REPL history
+## Features
+* [REPL](#repl-commands)
+  * with colorized tab-completion and zsh/fish style key suggestions
+  * automatically saves and reloads REPL history
+* [CLI](#cli-commands)
 
-# SCREENSHOT
 ![screenshot](/docs/screenshot.png)
 
-# INSTALLATION
+## Summary
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+
+- [Installation](#installation)
+- [REPL commands](#repl-commands)
+  - [GET &lt;key&gt;](#get-ltkeygt)
+  - [PUT &lt;key&gt; &lt;value&gt;](#put-ltkeygt-ltvaluegt)
+  - [DEL &lt;key&gt;](#del-ltkeygt)
+  - [LS](#ls)
+  - [START &lt;key-pattern&gt;](#start-ltkey-patterngt)
+  - [END &lt;key-pattern&gt;](#end-ltkey-patterngt)
+  - [LIMIT &lt;number&gt;](#limit-ltnumbergt)
+  - [REVERSE](#reverse)
+- [CLI commands](#cli-commands)
+  - [--get &lt;key&gt;](#--get-ltkeygt)
+  - [--put &lt;key&gt;](#--put-ltkeygt)
+  - [--del &lt;key&gt;](#--del-ltkeygt)
+  - [--batch &lt;operations&gt;](#--batch-ltoperationsgt)
+  - [--keys](#--keys)
+  - [--values](#--values)
+  - [--all](#--all)
+  - [--start &lt;key-pattern&gt;](#--start-ltkey-patterngt)
+  - [--end &lt;key-pattern&gt;](#--end-ltkey-patterngt)
+  - [--match &lt;key-pattern&gt;](#--match-ltkey-patterngt)
+  - [--limit &lt;number&gt;](#--limit-ltnumbergt)
+  - [--reverse](#--reverse)
+  - [--line](#--line)
+  - [--length](#--length)
+  - [--valueEncoding &lt;string&gt;](#--valueencoding-ltstringgt)
+  - [--location &lt;string&gt;](#--location-ltstringgt)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+## Installation
 
 ```
 $ npm install -g lev
 ```
 
-# BASIC USAGE
+## REPL commands
 
-```
+Start the REPL
+```sh
+# in the current directory
+$ lev
+# somewhere else
 $ lev path/to/db
 ```
 
-# REPL COMMANDS
 Use upper or lower case for the following commands.
 
-## GET &lt;key&gt;
+### GET &lt;key&gt;
 Get a key from the database.
 
-## PUT &lt;key&gt; &lt;value&gt;
+### PUT &lt;key&gt; &lt;value&gt;
 Put a value into the database. If you have `keyEncoding` or `valueEncoding`
 set to `json`, these values will be parsed from strings into `json`.
 
-## DEL &lt;key&gt;
+### DEL &lt;key&gt;
 Delete a key from the database.
 
-## LS
+### LS
 Get all the keys in the current range.
 
-## START &lt;key-pattern&gt;
+### START &lt;key-pattern&gt;
 Defines the start of the current range. You can also use `GT` or `GTE`.
 
-## END &lt;key-pattern&gt;
+### END &lt;key-pattern&gt;
 Defines the end of the current range. You can also use `LT` or `LTE`.
 
-## LIMIT &lt;number&gt;
+### LIMIT &lt;number&gt;
 Limit the number of records in the current range (defaults to 5000).
 
-## REVERSE
+### REVERSE
 Reverse the records in the current range.
 
-# CLI COMMANDS
-These all match the parameters used with
-[`levelup`](https://github.com/rvagg/node-levelup). The default encoding
-for the database is set to `json`.
+## CLI commands
+These all match the parameters used with [`levelup`](https://github.com/rvagg/node-levelup). The default encoding for the database is set to `json`.
 
-## --get &lt;key&gt;
+### --get &lt;key&gt;
 Get a value
 ```sh
 lev --get foo
 ```
 
-## --put &lt;key&gt;
+### --put &lt;key&gt;
 Put a value
 ```sh
 lev --put foo --value bar
 ```
 
-## --del &lt;key&gt;
+### --del &lt;key&gt;
 Delete a value
 ```sh
 lev --del foo
 ```
 
-## --batch &lt;operations&gt;
+### --batch &lt;operations&gt;
 Put or delete several values, using [`levelup` batch syntax](https://github.com/Level/levelup#dbbatcharray-options-callback-array-form)
 ```sh
 lev --batch '[
@@ -120,20 +155,20 @@ gzip -dk leveldb.export.gz
 lev /tmp/my-new-db --batch leveldb.export
 ```
 
-## --keys
+### --keys
 List all the keys in the current range. Will tabularize the output by default (see `--line`).
 ```sh
 lev --keys
 ```
 
-## --values
+### --values
 List all the values in the current range.
 Emit as a new-line delimited stream of json.
 ```sh
 lev --values
 ```
 
-## --all
+### --all
 List all the keys and values in the current range.
 Emit as a new-line delimited stream of json.
 ```sh
@@ -145,7 +180,7 @@ lev --all > leveldb.export
 lev /tmp/my-new-db --batch leveldb.export
 ```
 
-## --start &lt;key-pattern&gt;
+### --start &lt;key-pattern&gt;
 Specify the start of the current range. You can also use `gt` or `gte`.
 ```sh
 # output all keys after 'foo'
@@ -156,7 +191,7 @@ lev --keys --gte 'foo'
 lev --values --start 'foo'
 ```
 
-## --end &lt;key-pattern&gt;
+### --end &lt;key-pattern&gt;
 Specify the end of the current range. You can also use `lt` and `lte`.
 ```sh
 # output all keys before 'fooz'
@@ -169,7 +204,7 @@ lev --values --end 'fooz'
 lev --keys --start 'foo' --end 'fooz'
 ```
 
-## --match &lt;key-pattern&gt;
+### --match &lt;key-pattern&gt;
 Filter keys or values by a pattern applied on the key
 ```sh
 lev  --keys --match 'f*'
@@ -181,28 +216,28 @@ lev --match 'f*'
 
 See [`minimatch` doc](https://github.com/isaacs/minimatch#readme) for patterns
 
-## --limit &lt;number&gt;
+### --limit &lt;number&gt;
 Limit the number of records emitted in the current range.
 ```sh
 lev --keys --limit 10
 lev --values --start 'foo' --end 'fooz' --limit 100
 lev --match 'f*' --limit 10
 ```
 
-## --reverse
+### --reverse
 Reverse the stream.
 ```sh
 lev --keys --reverse
 lev --keys --start 'foo' --end 'fooz' --limit 100 --reverse
 ```
 
-## --line
+### --line
 Output one key per line (instead of the default tabularized output)
 ```sh
 lev --keys --line
 ```
 
-## --length
+### --length
 Output the length of the current range
 ```sh
 # Count all the key/value pairs in the database
@@ -211,13 +246,13 @@ lev --length
 lev --start 'foo' --end 'fooz' --length
 ```
 
-## --valueEncoding &lt;string&gt;
+### --valueEncoding &lt;string&gt;
 Specify the encoding for the values (Defaults to 'json').
 ```sh
 lev --values --valueEncoding buffer
 ```
 
-## --location &lt;string&gt;
+### --location &lt;string&gt;
 Specify the path to the LevelDB to use. Defaults to the current directory.
 ```sh
 lev --location /tmp/test-db --keys

package.json

@@ -5,7 +5,8 @@
   "bin": "./bin/lev",
   "description": "CLI & REPL for LevelDB",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "update-toc": "doctoc README.md"
   },
   "repository": {
     "type": "git",
@@ -44,5 +45,8 @@
     "split": "^1.0.1",
     "tabulate": "^1.0.0",
     "xtend": "^4.0.0"
+  },
+  "devDependencies": {
+    "doctoc": "^1.3.1"
   }
 }