Skip to content

Commit

Permalink
add exemple of info method on readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Gleider committed May 2, 2018
1 parent 5561637 commit bc3deeb
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,30 @@ podcastSearch.tagName("news-politics", 5)
});
// print list of 5 title podcasts that have the tag news-politics.
```

### info(url)

Informations about podcast that was passed by parameter.

#### Arguments

| Argument | Type | Options |
| ----------- | ------ | ---------------- |
| url | string | 'Url query'

#### Return
A promise object containing a podcast.
The functions are the same that the search method.

#### Example

```
podcastSearch.info("http://jovemnerd.ig.com.br/categoria/nerdcast/feed/rss/")
.then(data => {
console.log(data.title);
});
// print 'Nerdcast'.
```
## License

The MIT License (MIT)
Expand Down

0 comments on commit bc3deeb

Please sign in to comment.