Skip to content

Commit

Permalink
Fixed some punctuation and sentence structure for readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jwithington committed Jan 20, 2017
1 parent e04d919 commit adf1902
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Expand Up @@ -12,9 +12,9 @@ A Liquid tag plugin for Jekyll blogging engine that embeds Tweets, Timelines and

## Description

**jekyll-twitter-plugin** is a Liquid tag plugin for [Jekyll](http://jekyllrb.com/) that enables Twitter content to be used in any pages generated by Jekyll, content is fetched from the [Twitter Publish platform](https://publish.twitter.com).
**jekyll-twitter-plugin** is a Liquid tag plugin for [Jekyll](http://jekyllrb.com/) that enables Twitter content to be used in any pages generated by Jekyll. Content is fetched from the [Twitter Publish platform](https://publish.twitter.com).

The [Publish platform](https://publish.twitter.com) allows Twitter users to curate content for display outside of Twitter, you can display many different types of content with the familiar Twitter styling. We use this API and allow any customisation of the content that is accepted by the Twitter publish platform.
The [Publish platform](https://publish.twitter.com) allows Twitter users to curate content for display outside of Twitter. You can display many different types of content with the familiar Twitter styling. We use this API and allow any customisation of the content that is accepted by the Twitter publish platform.

> You can now embed any Twitter content in your Jekyll powered blog!
Expand Down Expand Up @@ -57,7 +57,7 @@ The plugin supports the following features:

## Getting Started

As mentioned by [Jekyll's documentation](http://jekyllrb.com/docs/plugins/#installing-a-plugin) you have two options; manually import the source file or require the plugin as a `gem`.
As mentioned by [Jekyll's documentation](http://jekyllrb.com/docs/plugins/#installing-a-plugin) you have two options; manually import the source file, or require the plugin as a `gem`.


#### Require gem
Expand Down Expand Up @@ -89,7 +89,7 @@ $ wget https://raw.githubusercontent.com/rob-murray/jekyll-twitter-plugin/master

#### Plugin tag usage

To use the plugin, in your source content use the tag `twitter` and then pass additional options to the plugin, these are passed to the API.
To use the plugin, in your source content use the tag `twitter` and then pass additional options to the plugin. These are passed to the API.

```liquid
{% plugin_type twitter_url *options %}
Expand All @@ -107,7 +107,7 @@ To use the plugin, in your source content use the tag `twitter` and then pass ad

### Supported Twitter URLs

The Twitter URLs that are supported depends on Twitter, we pass the url and all parameters to the API - check [Twitter Publish platform](https://publish.twitter.com) for availability. Here is documentation for some common types:
The Twitter URLs that are supported depend on Twitter. We pass the url and all parameters to the API - check [Twitter Publish platform](https://publish.twitter.com) for availability. Here is documentation for some common types:

##### Tweet:

Expand All @@ -124,9 +124,9 @@ The Twitter URLs that are supported depends on Twitter, we pass the url and all

### Customisation

All pairs of options and values after the URL are passed to the API, the parameters must be in pairs with the option as the key: `option=value`.
All pairs of options and values after the URL are passed to the API. The parameters must be in pairs with the option as the key: `option=value`.

For exampled if you wanted to limit the width of the embedded content then the API supports a `maxwidth` option so you could construct the tag as below to limit it to a value of 500 (pixels).
For example, if you want to limit the width of the embedded content then the API supports a `maxwidth` option so you could construct the tag as below to limit it to a value of 500 (pixels).

```liquid
{% twitter https://twitter.com/jekyllrb maxwidth=500 %}
Expand All @@ -149,11 +149,11 @@ All content will be rendered inside a div with the class `jekyll-twitter-plugin`
</div>
```

If something goes wrong then a basic error message will be displayed;
If something goes wrong, then a basic error message will be displayed:

> Tweet could not be processed
If we receive an error from the API then a message will be cached and rendered something like this below. If its a 404 then this suggests the Tweet is protected or deleted and it is not fetched again, and again. If the Tweet is restored then simply delete the cached response from `.tweet-cache` directory and build again.
If we receive an error from the API then a message will be cached and rendered something like this below. If it's a 404, then this suggests the Tweet is protected or deleted. I will not be fetched again and again. If the Tweet is restored, then simply delete the cached response from `.tweet-cache` directory and build again.

```html
<div class='jekyll-twitter-plugin'>
Expand All @@ -163,7 +163,7 @@ If we receive an error from the API then a message will be cached and rendered s

### Caching

Twitter API responses can be cached to speed up Jekyll site builds. The reponses will be cached in a directory within your Jekyll project called `.tweet-cache`, this should not be committed to source control.
Twitter API responses can be cached to speed up Jekyll site builds. The reponses will be cached in a directory within your Jekyll project called `.tweet-cache`. This should not be committed to source control.

Caching is enabled by using the `twitter` tag.

Expand Down

0 comments on commit adf1902

Please sign in to comment.