From 294e86276e2a2f3497b22002d9c761a9e7e55ac4 Mon Sep 17 00:00:00 2001 From: Gleider Date: Mon, 30 Apr 2018 18:03:49 -0300 Subject: [PATCH] improving readme file example --- README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/README.md b/README.md index 20e985e..62061d9 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,41 @@ import * as podcastSearch from 'podcast-search'; var podcastSearch = require('podcast-search'); ``` +### UMD in Browser + +``` + + + + + +``` + +## Methods + +Follow the methods that the library provides. + +### search(query) + +Search for podcasts with provided query. + +#### Arguments + +| Argument | Type | Options | +| ----------- | ------ | -------------- | +| query | string | 'Search query' | + +#### Return +A promise object containing a list os podcasts. + +#### Example +``` +podcastSearch.search('nerdcast') + .then(data => { + //do what you want with the data + }) +``` + ## License The MIT License (MIT)