Skip to content

Update README.md #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
btakashi wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,22 @@ This package presents a simple and fast function to deserialize [JSON API](http:

## Install

`npm install jsonapi-deserializer --save`
`npm install jsonapi-deserializer-es --save`

## Usage

```
var jsonapiDocument = { /* ... */ };

// Node
var deserialize = require('jsonapi-deserializer').deserialize;
var deserialize = require('jsonapi-deserializer-es').deserialize;
var simpleObj = deserialize(jsonapiDocument);

// ES6 - Typescript
import { deserialize } from 'jsonapi-deserializer';
import { deserialize } from 'jsonapi-deserializer-es';
let simpleObj = deserialize(jsonapiDocument);
```

## Run tests

Get the repo (`git clone`), install dependencies (`npm install`) and run the default test suite (`npm test`). There's not many tests since they're being developed as necessary. [Open a new issue](https://github.com/ShadowManu/jsonapi-deserializer/issues/new) if you find incorrect/undesired behavior.
Get the repo (`git clone`), install dependencies (`npm install`) and run the default test suite (`npm test`). There's not many tests since they're being developed as necessary. [Open a new issue](https://github.com/Styria-Digital/jsonapi-deserializer-es/issues/new) if you find incorrect/undesired behavior.