Skip to content
This repository has been archived by the owner on Aug 15, 2019. It is now read-only.

Commit

Permalink
Readme updated with options
Browse files Browse the repository at this point in the history
  • Loading branch information
jackfranklin committed Aug 25, 2010
1 parent 98f9686 commit 3f9a9a2
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,19 @@ Skype: jack_franklin

PLEASE PLEASE PLEASE use the minified version for live sites.

If you want to fork this please do and make your edits. Also, let me hear about it! I'd love to see what you're all up to !
If you want to fork this please do and make your edits. Also, let me hear about it! I'd love to see what you're all up to !

Options:
//The values of each variable are the defaults
username: 'kyle', //your forrst username [REQUIRED]
count: 5, //number of posts you want to retrieve, cannot be more than 10 [REQUIRED]
since: null, //see below for an explanation
lastid: null, //see below for an explanation
debugMode: false, //if you are having issues turn this to true, it outputs an array of errors.
callback: function() {}, //a function to run once the data is retrieved [REQUIRED]
apiVersion: 'v1', //version of the API - used incase Forrst suddenly change their version.
cantFetchPosts: 'Sorry, there has been a problem fetching information from Forrst.'
//the error message shown if there was an issue with Forrst.
fetchedError: 'We managed to interact with Forrst but all of your posts are set to private, so we cannot display them here.'
//error shown if Forrst was contacted but no data was returned.
//Usually this is due to posts being set as private.

0 comments on commit 3f9a9a2

Please sign in to comment.