Skip to content

Commit

Permalink
?
Browse files Browse the repository at this point in the history
  • Loading branch information
LucasLeandro1204 committed Mar 24, 2017
1 parent 80bfc95 commit ab05135
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
#Pornsearch
# Pornsearch

Easy way to search for porn content on the [Pornhub](http://pornhub.com/)

##Simple search
## Simple search

```js
const pornsearch = require('../lib/pornsearch');

Expand All @@ -11,7 +13,8 @@ pornsearch.videos('boobs')
});
```

##Installation
## Installation

Via GIT:
```bash
$ git clone git://github.com/LucasLeandro1204/api.git node_modules/pornsearch
Expand All @@ -22,6 +25,7 @@ $ npm install pornsearch
```

##Output

If has success, the return will be an array with ~~possibly less than~~ 20 videos, structured as
```js
{
Expand All @@ -35,7 +39,8 @@ If has error, will be returned a message like
No results for search related to *relation* in page *page* and category number *number*
```

##Usage
## Usage

First require Pornsearch
```js
const pornsearch = require('../lib/pornsearch');
Expand All @@ -62,6 +67,6 @@ You can too search by category number (look at Pornhub and search through for it
pornsearch.videos('young', 5, 41);
```

###To do
### To do

- [ ] Search for GIF

0 comments on commit ab05135

Please sign in to comment.