etcd-dump - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

 {
     "name": "etcd-dump",
-    "version": "0.0.1",
+    "version": "0.0.2",
     "description": "A tool for dumping and restoring etcd",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

 etcd-dump
 =========
 
-Command line utility for dumping/restoring etcd
+Command line utility for dumping/restoring etcd.
+
+This tool intentionally does not care for etcd's inner workings, it's sole purpouse is to dump/restore the state of database by dumping all it's `key/value` `pairs` to `json` and then restoring them back.
+
+This is useful for version and server migrations.
+
+I built it because I needed it.
+
+## Installing
+
+```
+npm install -g etcd-dump
+```
+
+## Usage
+
+### Dumping :
+
+```bash
+$ etcd-dump dump
+// outputs an etcd_dump.json
+```
+
+### Restoring :
+
+```bash
+$ etcd-dump restore
+Restored successfuly
+// Reads in the etcd_dump.json and restores it's values to the DB
+```
+
+### Help :
+
+```bash
+$ etcd-dump
+
+  Usage: etcd-dump.js [options] [command]
+
+  Commands:
+
+    dump
+    restore
+
+  Options:
+
+    -h, --help              output usage information
+    -V, --version           output the version number
+    -f, --file [json_file]  Path to JSON dump file for dumping/storing
+```

No alert changes

Improved metrics

Total package byte prevSize

15110

6.09%

Number of lines in readme file

53

960%

No dependency changes