ledger-rest - npm Package Compare versions

Comparing version 0.1.0 to 0.2.0

package.json

 {
   "name": "ledger-rest",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "REST web service API to access ledger cli data.",
@@ -39,3 +39,3 @@ "repository": {
     "JSONStream": "~0.8.0",
-    "ledger-cli": "0.1.1",
+    "ledger-cli": "0.2.0",
     "lodash": "~2.4.1",
@@ -42,0 +42,0 @@ "restify": "~2.6.1"

README.md

@@ -7,2 +7,4 @@ # ledger-rest
 
+MIT License
+
 ## Dependencies
@@ -17,3 +19,5 @@
 
-    brew install ledger --HEAD
+```
+brew install ledger --HEAD
+```
 
@@ -26,16 +30,36 @@ The `--HEAD` option is required to install version 3.x.
 
-    npm install ledger-rest
-    
+```
+npm install ledger-rest
+```
+
 Use the `LedgerRest` class to create a new RESTful server and start listening on a given port.
 
-    var LedgerRest = require('ledger-rest').LedgerRest;
-    
-    var server = new LedgerRest({ file: 'path/to/ledger/journal/file.dat' });
+```js
+var LedgerRest = require('ledger-rest').LedgerRest;
 
-    server.listen(3000);
+var server = new LedgerRest({ file: 'path/to/ledger/journal/file.dat' });
 
+server.listen(3000);
+```
+
 Or use the command line runner to start a server listening on the given port and serving a single Ledger `.dat` file.
 
-	npm install ledger-rest -g
+```
+npm install ledger-rest -g
 	
-    ledger-rest -p <port> -f path/to/ledger/journal/file.dat
+ledger-rest -p <port> -f path/to/ledger/journal/file.dat
+```
+
+To confirm the server is listening:
+
+```
+curl -H "Content-Type: application/json" http://localhost:<port>/version
+    
+{"version":"3.1.1-20160111"}
+```
+
+The following endpoints are available:
+
+* /version
+* /balance
+* /register

No alert changes

Improved metrics

Total package byte prevSize

15275

increased by9.62%

Number of package files

15

increased by7.14%

Number of lines in readme file

63

increased by65.79%

Dependency changes

• + Addedledger-cli@0.2.0(transitive)

• - Removedledger-cli@0.1.1(transitive)

• Updatedledger-cli@0.2.0