Skip to content

update readme for npm package #30

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
erichoog wants to merge 1 commit into
base: feature/v2
Choose a base branch
from
Open

update readme for npm package #30

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
14 changes: 11 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,18 @@ Roadmap

Usage
=====
```
// this module isn't published to NPM yet, so you have to clone it to the node_modules folder in your machine, beforehand
var vendSdk = require('vend-nodejs-sdk')({});

First, install the npm module [vend-nodejs-sdk](https://www.npmjs.com/package/vend-nodejs-sdk) into your project directory:

`npm install vend-nodejs-sdk`

Reference the package in your application file:

`var vendSdk = require('vend-nodejs-sdk')({});`

Start using the SDK:

```
var args = vendSdk.args.products.fetch();
args.orderBy.value = 'id';
args.page.value = 1;
Expand Down