Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
JDMcKinstry committed Mar 8, 2016
1 parent 2edda75 commit d545e93
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ This simple and easy to use jQuery Plugin makes calling RSS Feeds simple and eas
- **output**: "*json* || *json_xm*l || *xml*" Defaults to "json"
- **rss**: String url to path of RSS Feed. [*Can be passed as simple string parameter instead*]
- **userip**: Setting this to the end user's ip will help Google know this is not a bot making unfeathered calls, and reduce the chance of a erroneous return.
- ***doLog***: Boolean whether or not to send information to the `console.log`

### Overwritable Methods
#### In general, the following methods should not be changed, but if you'd like to change how the Plugin works upon each ajax call, here you go!
Expand All @@ -24,3 +25,24 @@ This simple and easy to use jQuery Plugin makes calling RSS Feeds simple and eas

## Example jsFiddle Play
http://jsfiddle.net/SpYk3/Pp44S/

##Full Example Options Use

$.jQRSS({
count: 10,
historical: false,
output: 'json',
rss: 'http://www.fake-feed.com/myRSS/',
userip: '<? $_USERIP; ?>',
beforeSend: function (jqXHR, settings) {
alert(settings.ajaxID);
},
error: function(jqXHR, textStatus, errorThrown) {
alert(errorThrown);
},
success: function(data, textStatus, jqXHR) {
console.log(data.responseData['feed']);
}
}); // no need for callback since your already manipulating the success method, thus a cb would never be called anyway


0 comments on commit d545e93

Please sign in to comment.