added examples

SignalK · Aug 13, 2015 · 42d645a · 42d645a
1 parent fc4e480
commit 42d645a
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -3,4 +3,27 @@ NMEA0183-utilities
 
 [![Build Status](https://travis-ci.org/SignalK/nmea0183-utilities.svg)](https://travis-ci.org/SignalK/nmea0183-utilities)
 
-Various utilities for transforming NMEA0183 units into SI units for use in Signal K. 
+Various utilities for transforming NMEA0183 units into SI units for use in Signal K. 
+
+
+Installation
+============
+
+`npm install nmea0183-utilities`
+
+
+Some examples
+=============
+
+```javascript
+var utils = require('nmea0183-utilities');
+
+// Transform 3 knots into m/s
+var ms = utils.transform(3, 'knots', 'ms');
+
+// Generate a source object for SignalK from a sentence
+var source = utils.source('VDM');
+
+// Generate a timestamp from a NMEA0183 time and date field
+var source = utils.source('220104', '171089');
+```
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "nmea0183-utilities",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Various utilities for transforming NMEA0183 units into SI units for use in SK.",
   "main": "index.js",
   "scripts": {