README.md in bridgetown-feed-1.1.2 vs README.md in bridgetown-feed-1.1.3

- old
+ new

@@ -1,8 +1,8 @@ # Bridgetown Feed plugin -A Bridgetown plugin to generate an Atom (RSS-like) feed of your Bridgetown posts +A Bridgetown plugin to generate an Atom (RSS-like) feed of your Bridgetown posts and other collection documents. ## Installation Run this command to add this plugin to your site's Gemfile: @@ -14,18 +14,22 @@ ```ruby gem 'bridgetown-feed', group: "bridgetown_plugins" ``` -## Usage +The plugin exposes a helper tag to expose the appropriate meta tags to support automated discovery of your feed. -The plugin will automatically generate an Atom feed at `/feed.xml`. +Simply place `{% feed_meta %}` someplace in your template's `<head>` section to output the necessary metadata. -### Meta tags +### Atom is nice and all, but what about JSON Feed? -The plugin exposes a helper tag to expose the appropriate meta tags to support automated discovery of your feed. Simply place `{% feed_meta %}` someplace in your template's `<head>` section, to output the necessary metadata. +[It's on our roadmap.](https://github.com/bridgetownrb/bridgetown-feed/issues/1) 🙂 +## Usage + +The plugin will automatically generate an Atom feed at `/feed.xml`. + ### Optional configuration options The plugin will automatically use any of the following metadata variables if they are present in your site's `_data/site_metadata.yml` file. * `title` or `name` - The title of the site, e.g., "My awesome site" @@ -118,11 +122,11 @@ author: marina ``` ### SmartyPants -The plugin uses [Bridgetown's `smartify` filter](https://bridgetownrb.com/docs/templates/) for processing the site title and post titles. This will translate plain ASCII punctuation into "smart" typographic punctuation. This will not render or strip any Markdown you may be using in a title. +The plugin uses [Bridgetown's `smartify` filter](https://www.bridgetownrb.com/docs/liquid/filters) for processing the site title and post titles. This will translate plain ASCII punctuation into "smart" typographic punctuation. This will not render or strip any Markdown you may be using in a title. Bridgetown's `smartify` filter uses [kramdown](https://kramdown.gettalong.org/options.html) as a processor. Accordingly, if you do not want "smart" typographic punctuation, disabling them in kramdown in your `bridgetown.config.yml` will disable them in your feed. For example: ```yml kramdown: @@ -131,13 +135,9 @@ ``` ### Custom styling Want to style what your feed looks like in the browser? Simply add an XSLT at `/feed.xslt.xml` and Bridgetown Feed will link to the stylesheet. - -## Why Atom, and not RSS? - -Great question. In short, Atom is a better format. Think of it like RSS 3.0. For more information, see [this discussion on why we chose Atom over RSS 2.0](https://github.com/bridgetown/bridgetown-rss-feed/issues/2). ## Categories Bridgetown Feed can generate feeds for each category. Simply define which categories you'd like feeds for in your config: