README.md in jekyll-twitter-plugin-1.0.1 vs README.md in jekyll-twitter-plugin-1.1.0

- old
+ new

@@ -7,11 +7,11 @@ ### Description A Liquid tag plugin for [Jekyll](http://jekyllrb.com/) that enables Twitter content to be used in any content served by Jekyll, content is fetched from the [Twitter API](https://dev.twitter.com/home). -It is based on the original Jekyll Tweet Tag from [scottwb](https://github.com/scottwb/jekyll-tweet-tag) which has not been updated since Twitter updated their API to require Oauth. This version uses the excellent [Twitter gem](https://github.com/sferik/twitter) to make requests and handle authentication. +It is based on the original Jekyll Tweet Tag from [scottwb](https://github.com/scottwb/jekyll-tweet-tag) which has not been updated since Twitter updated their API to require certain preconditions. This version uses the excellent [Twitter gem](https://github.com/sferik/twitter) to make requests and handle authentication. This plugin replaces the broken plugin mentioned above and uses a different tag name and API - this is by design so that the two plugins can be used, if the original gets fixed. ### Features @@ -58,42 +58,45 @@ #### Credentials Your Twitter application authentication credentials are private - do not distribute these! As such this plugin requires your credentials as Environment variables, it requires the following keys to be set; -* **TWITTER_CONSUMER_KEY** -* **TWITTER_CONSUMER_SECRET** -* **TWITTER_ACCESS_TOKEN** -* **TWITTER_ACCESS_TOKEN_SECRET** +* TWITTER_CONSUMER_KEY +* TWITTER_CONSUMER_SECRET +* TWITTER_ACCESS_TOKEN +* TWITTER_ACCESS_TOKEN_SECRET ```bash $ export TWITTER_CONSUMER_KEY=foo etc. ``` #### Plugin tag usage To use the plugin, in your source content use the tag `twitter` and then pass additional parameters to the plugin. -```ruby -{% plugin_type api_type params %} +```liquid +{% plugin_type api_type *params %} ``` * `plugin_type` - Either `twitter` or `twitternocache`. * `api_type` - The Twitter API to use, check below for supported APIs. -* `params` - Parameters for the API separated by spaces. +* `*params` - Parameters for the API separated by spaces. Refer below and to respective Twitter API documentation for available parameters. ### Supported Twitter APIs The following Twitter APIs are supported. #### Oembed The [oembed](https://dev.twitter.com/rest/reference/get/statuses/oembed) API returns html snippet to embed in your app, this will be rendered in the familiar Twitter style. -```ruby -{% twitter oembed status_url %} +```liquid +{% twitter oembed status_url *options %} + # Example {% twitter oembed https://twitter.com/rubygems/status/518821243320287232 %} +# With options +{% twitter oembed https://twitter.com/rubygems/status/518821243320287232 align='right' width='350' %} ``` ### Output As with the original plugin, all content will be rendered inside a div with the classes 'embed' and 'twitter'