Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
IonicaBizau committed May 3, 2016
1 parent 94f936b commit 1d2bd0b
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions DOCUMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ A scraping module for humans.

#### Params
- **String|Object** `url`: The page url or request options.
- **Object** `opts`: The options passed to `scrapeCheerio` method.
- **Object** `opts`: The options passed to `scrapeHTML` method.
- **Function** `cb`: The callback function.

#### Return
- **Promise** A promise object.

### `scrapeIt.scrapeCheerio($, opts)`
### `scrapeIt.scrapeHTML($, opts)`
Scrapes the data in the provided element.

#### Params
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,13 +72,13 @@ A scraping module for humans.

#### Params
- **String|Object** `url`: The page url or request options.
- **Object** `opts`: The options passed to `scrapeCheerio` method.
- **Object** `opts`: The options passed to `scrapeHTML` method.
- **Function** `cb`: The callback function.

#### Return
- **Promise** A promise object.

### `scrapeIt.scrapeCheerio($, opts)`
### `scrapeIt.scrapeHTML($, opts)`
Scrapes the data in the provided element.

#### Params
Expand Down

0 comments on commit 1d2bd0b

Please sign in to comment.