KevinMidboe/moviedb
1
0
Fork 0
mirror of https://github.com/KevinMidboe/moviedb.git synced 2025-10-29 17:50:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #59 from amilajack/patch-1

Browse Source 
Updated readme examples to es6
This commit is contained in:
Dan Zajdband
2016-11-11 12:37:06 -05:00
committed by GitHub
parent 8794fe4bb5 179a0244f7
commit 2837f7a902
1 changed files with 33 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

85
Readme.md
View File

@@ -1,63 +1,44 @@
# MovieDB MovieDB
=======
[![Build Status](https://travis-ci.org/impronunciable/moviedb.svg?branch=master)](https://travis-ci.org/impronunciable/moviedb)
[![NPM version](https://badge.fury.io/js/moviedb.svg)](http://badge.fury.io/js/moviedb)
[![Dependency Status](https://img.shields.io/david/impronunciable/moviedb.svg)](https://david-dm.org/impronunciable/moviedb)
[![npm](https://img.shields.io/npm/dm/moviedb.svg?maxAge=2592000)]()
node.js library that makes the interaction with themoviedb.org V3 API easy. node.js library that makes the interaction with themoviedb.org V3 API easy.
## How to install ## Installation
```bash
npm install moviedb npm install moviedb --save
```
## How to use ## Usage
Require MovieDB and provide your themoviedb.org API KEY Require MovieDB and provide your themoviedb.org API KEY
```js
var MovieDB = require('moviedb')('your api key'); const MovieDB = require('moviedb')('your api key');
```
Use the api methods as you want, for example: Use the api methods as you want, for example:
```js
mdb.searchMovie({query: 'Alien' }, function(err, res){ mdb.searchMovie({ query: 'Alien' }, (err, res) => {
console.log(res); console.log(res);
}); });
```
or or
```js
mdb.movieInfo({id: 666}, function(err, res){ mdb.movieInfo({ id: 666}, (err, res) => {
console.log(res); console.log(res);
}); });
```
now you can also make chain calls now you can also make chain calls
```js
mdb.searchMovie({query: 'Zoolander' }, function(err, res){ mdb
console.log(res); .searchMovie({ query: 'Zoolander' }, (err, res) => {
}).movieInfo({id: 123}, function(err, res){ console.log(res);
console.log(res); })
}); .movieInfo({ id: 123 }, (err, res) => {
console.log(res);
});
```
## Available methods ## Available methods
All themoviedb.org API v3 methods included. Endpoint methods are included on [a wiki page](https://github.com/impronunciable/moviedb/wiki/Library-endpoints) All themoviedb.org API v3 methods included. Endpoint methods are included on [a wiki page](https://github.com/impronunciable/moviedb/wiki/Library-endpoints)
## License
=======
(The MIT License)
Copyright (c) 2012 Dan Zajdband <dan.zajdband@gmail.com>
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.