docs 📝, fix test command 🐛

derhuerst · May 24, 2016 · 213c5cd · 213c5cd
1 parent 0b8f0cd
commit 213c5cd
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 3 deletions.
diff --git a/package.json b/package.json
@@ -15,7 +15,7 @@
 		"tap-min": "^1.1"
 	},
 	"scripts": {
-		"test":          "./test.js",
-		"prepublish":    "npm test"
+		"test":       "tape test.js | tap-min",
+		"prepublish": "npm test"
 	}
 }
diff --git a/readme.md b/readme.md
@@ -2,7 +2,28 @@
 
 **Parse ticket information from the VBB HAFAS API.**
 
-todo: example
+```js
+{
+	  name:  'foo'
+	, price: 321
+	, shpCtx: '{"TLS": "B3TK"}'
+}
+```
+
+will be parsed to
+
+```js
+{
+	  name:      'foo'
+	, price:     3.21
+	, amount:    1
+	, fullDay:   true
+	, group:     true
+	, tariff:    'Berlin'
+	, coverage:  'ABC'
+	, variant:   '1 day, group'
+}
+```
 
 [![npm version](https://img.shields.io/npm/v/vbb-parse-ticket.svg)](https://www.npmjs.com/package/vbb-parse-ticket)
 [![build status](https://img.shields.io/travis/derhuerst/vbb-parse-ticket.svg)](https://travis-ci.org/derhuerst/vbb-parse-ticket)