Skip to content

Commit

Permalink
add asciinema
Browse files Browse the repository at this point in the history
  • Loading branch information
lacymorrow committed Feb 3, 2018
1 parent f19209f commit a6f6252
Showing 1 changed file with 38 additions and 36 deletions.
74 changes: 38 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,38 @@
# movie-info [![Build Status](https://travis-ci.org/lacymorrow/movie-info.svg?branch=master)](https://travis-ci.org/lacymorrow/movie-info) [![npm version](https://badge.fury.io/js/movie-info.svg)](https://badge.fury.io/js/movie-info)

> Get information, images, rating, description, etc. about a movie.
> Fetch information, images, rating, description, etc. about a movie.
[![asciicast](https://asciinema.org/a/160835.png)](https://asciinema.org/a/160835)


## Install

```bash
$ npm install --save movie-info
$ npm install -g movie-info
```


#### From the command line

```bash
$ movie-info --help

Usage
$ movie-info movie [year]

Example
$ movie-info 'Oceans Eleven' 1960
//=> { ... }
```
## Usage
```bash
$ npm install --save movie-info
```
```js

var movieInfo = require('movie-info');
Expand All @@ -27,27 +48,6 @@ movieInfo('Oceans Eleven', '1960', function (err, res) {
});
```
## API

### movieInfo(movie [, year ] , callback)

#### movie

*Required*
Type: `string`

Movie to search for.


#### year

Type: `string`

Optional movie year.


#### callback(err, res)

Returns an object in the following form:
```js
Expand All @@ -65,25 +65,27 @@ Returns an object in the following form:
}
```
## CLI
You can also use it as a CLI app by installing it globally:
## API
```bash
$ npm install --global movie-info
```
### movieInfo(movie [, year ] , callback)
#### Usage
#### movie
```bash
$ movie-info --help
*Required*
Type: `string`
Usage
$ movie-info movie [year]
Movie to search for.
Example
$ movie-info 'Oceans Eleven' 1960 { ... }
```
#### year
Type: `string`
Optional movie year.
#### callback(err, res)
## Related
Expand Down

0 comments on commit a6f6252

Please sign in to comment.