diff --git a/README.md b/README.md index 85bc555..94f7b6e 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ Ebay API Client for node js. + +[![npm version](https://badge.fury.io/js/ebay-node-api.svg)](https://badge.fury.io/js/ebay-node-api) +[![Build Status](https://travis-ci.org/ajay2507/ebay-node-api.svg?branch=master)](https://travis-ci.org/ajay2507/ebay-node-api) + # Installing ```shell @@ -31,6 +35,21 @@ Register your app here https://go.developer.ebay.com/quick-start-guide. - `limit` - optional(`Number`) - fetch items functionality - Number that limits the number of data you need in response. - `details` - optional(`Boolean`) - Get User Details functionality - true, if you need details about the user. +#### Example +## FetchItemsByKeyword +```javascript +const Ebay = require("ebay-node-api"); + +let ebay = new Ebay({ + clientID: "-- Client APP ID ----", + limit: 6 +}); +ebay.findItemsByKeywords("iphone").then((data) => { + console.log(data); // fetches top 6 results in form of JSON. +}, (error) => { + console.log(error); +}); +``` ## How do I run the tests? All test files are present inside test folder. You can run using