diff --git a/README.md b/README.md index b489bbf..4f86745 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,7 @@ and tooling design, basic parsing, among others. ## Installation +For basic use: ```shell $ npm install ig-serilaize ``` @@ -31,6 +32,10 @@ $ npm install ig-serilaize Or just download and drop [serialize.js](serialize.js) into your code. +```javascript +serialize = require('ig-serialize') +``` + ## Introduction @@ -198,6 +203,24 @@ If an object is encountered +## Running tests + +Get the development dependencies: +```shell +$ npm install -D +``` + +Run the tests: +```shell +$ npm test +``` + +To run the tests directly: +```shell +$ node ./test.js +``` + +