Skip to content

Commit

Permalink
README formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
elektronaut committed Dec 11, 2010
1 parent 6ce3058 commit 25216e9
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions README.rdoc
Expand Up @@ -33,25 +33,25 @@ Changing the query or options is pretty easy, just call liveTwitter again with t


=== Global options === Global options


*mode:* Valid options are 'search', 'user_timeline', 'list', 'home_timeline'. 'search' is the default. mode: Valid options are 'search', 'user_timeline', 'list', 'home_timeline'. 'search' is the default.
*rate:* Refresh rate, in milliseconds. The default is 15000. rate: Refresh rate, in milliseconds. The default is 15000.
*limit:* Maximum number of tweets to show at once. The default is 10. limit: Maximum number of tweets to show at once. The default is 10.
*imageSize:* Dimensions of profile image. The default is 24 pixels. imageSize: Dimensions of profile image. The default is 24 pixels.
*refresh:* Pass refresh: false to disable automatic refreshing. refresh: Pass refresh: false to disable automatic refreshing.
*rpp:* Results per page to request from the API. This defaults to the limit, increase it if you're filtering tweets. rpp: Results per page to request from the API. This defaults to the limit, increase it if you're filtering tweets.
*showAuthor:* Show username and profile picture. Defaults to false for user_timeline and true for all other modes. showAuthor: Show username and profile picture. Defaults to false for user_timeline and true for all other modes.
*filter:* Pass a function to filter tweets before displaying them. filter: Pass a function to filter tweets before displaying them.
*service:* Use another service with compatible API, for example 'identi.ca' or 'youraccount.status.net'. service: Use another service with compatible API, for example 'identi.ca' or 'youraccount.status.net'.
*timeLink:* Pass timeLink: false to disable the timestamp on tweets. timeLink: Pass timeLink: false to disable the timestamp on tweets.


=== Options for search === Options for search


*geocode:* Search tweets near a specific location. Example: '59.919151,10.749950,50km' geocode: Search tweets near a specific location. Example: '59.919151,10.749950,50km'
*lang:* Only show tweets in this language. Example: lang: 'fr' lang: Only show tweets in this language. Example: lang: 'fr'


=== Options for user_timeline === Options for user_timeline


*retweets:* Includes native retweets. Disabled by default. retweets: Includes native retweets. Disabled by default.


== A note on rate limiting == A note on rate limiting


Expand Down

0 comments on commit 25216e9

Please sign in to comment.