-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #5 from tushararora/chore/readme
Add readme
- Loading branch information
Showing
1 changed file
with
71 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
# node-trademark | ||
|
||
API wrapper for getting trademark information from http://www.markerapi.com | ||
|
||
[![Build Status][travis-image]][travis-url] | ||
|
||
## Install | ||
|
||
``` | ||
$ npm install node-trademark | ||
``` | ||
|
||
## Node/OS Target | ||
|
||
This repo is supposed to run fine on all major OS platforms and targets `Node.js >=7.0` | ||
|
||
## Quick Start | ||
|
||
You will need to sign up on http://www.markerapi.com and use credentials in the form of a set of username and password. You can get these from your markerapi profile. | ||
|
||
``` | ||
const markerApi = require('') | ||
markerApi.init({ | ||
username: '' | ||
password: '' | ||
}) | ||
``` | ||
|
||
## API | ||
|
||
You now have the ability to search trademark against a string. | ||
|
||
``` | ||
markerApi | ||
.getTrademark(searchQuery /* 'Microsoft' */) | ||
.then(function (res) { | ||
/** | ||
* Example JSON Response | ||
* | ||
* { | ||
* "count":1, | ||
* "trademarks":[{ | ||
* "serialnumber":"73236080", | ||
* "wordmark":"MICROSOFT", | ||
* "code":"GS0091", | ||
* "description":"Computer Programs", | ||
* "registrationdate":"07\/06\/1982" | ||
* }] | ||
* } | ||
*/ | ||
}) | ||
.catch(function (err) { | ||
/** | ||
* Handle error | ||
*/ | ||
}) | ||
``` | ||
|
||
## Development | ||
|
||
### Test | ||
|
||
``` | ||
npm test | ||
``` | ||
|
||
## Issues | ||
|
||
Please mention node and npm version while creating an issue. | ||
|
||
[travis-url]: https://travis-ci.org/tushararora/node-trademark |