mirror of
https://github.com/flynx/serialize.js.git
synced 2026-07-10 03:00:57 +00:00
docs...
Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
This commit is contained in:
parent
bd17b1df38
commit
f3287ca999
23
README.md
23
README.md
@ -24,6 +24,7 @@ and tooling design, basic parsing, among others.
|
|||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
|
For basic use:
|
||||||
```shell
|
```shell
|
||||||
$ npm install ig-serilaize
|
$ npm install ig-serilaize
|
||||||
```
|
```
|
||||||
@ -31,6 +32,10 @@ $ npm install ig-serilaize
|
|||||||
Or just download and drop [serialize.js](serialize.js) into your code.
|
Or just download and drop [serialize.js](serialize.js) into your code.
|
||||||
|
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
serialize = require('ig-serialize')
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
## Introduction
|
## 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
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user