diff --git a/Gemfile b/Gemfile index 7f93bb66..fa75df15 100644 --- a/Gemfile +++ b/Gemfile @@ -1,4 +1,3 @@ source 'https://rubygems.org' -# Specify your gem's dependencies in jekyll-rss-feed.gemspec gemspec diff --git a/README.md b/README.md index 096364a3..781c7e81 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,22 @@ -# Jekyll RSS feed plugin +# Jekyll Feed plugin -A Jekyll plugin to generate an RSS (Atom) feed for your Jekyll posts +A Jekyll plugin to generate an Atom (RSS-like) feed of your Jekyll posts -[![Build Status](https://travis-ci.org/jekyll/jekyll-rss-feed.svg)](https://travis-ci.org/jekyll/jekyll-rss-feed) [![Gem Version](https://badge.fury.io/rb/jekyll-rss-feed.svg)](http://badge.fury.io/rb/jekyll-rss-feed) +[![Build Status](https://travis-ci.org/jekyll/jekyll-feed.svg)](https://travis-ci.org/jekyll/jekyll-feed) [![Gem Version](https://badge.fury.io/rb/jekyll-feed.svg)](http://badge.fury.io/rb/jekyll-feed) ## Installation Add this line to your site's Gemfile: ```ruby -gem 'jekyll-rss-feed' +gem 'jekyll-feed' ``` And then add this line to your site's `_config.yml`: ```yml gems: - - jekyll-rss-feed + - jekyll-feed ``` ## Usage @@ -51,9 +51,13 @@ Additionally, the plugin will use the following values, if present in a post's Y 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 `` section, to output the necessary metadata. +## 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/jekyll/jekyll-rss-feed/issues/2). + ## Contributing -1. Fork it (https://github.com/jekyll/jekyll-rss-feed/fork) +1. Fork it (https://github.com/jekyll/jekyll-feed/fork) 2. Create your feature branch (`git checkout -b my-new-feature`) 3. Commit your changes (`git commit -am 'Add some feature'`) 4. Push to the branch (`git push origin my-new-feature`) diff --git a/jekyll-rss-feed.gemspec b/jekyll-feed.gemspec similarity index 79% rename from jekyll-rss-feed.gemspec rename to jekyll-feed.gemspec index 15b24b4a..6bf5dbd1 100644 --- a/jekyll-rss-feed.gemspec +++ b/jekyll-feed.gemspec @@ -1,12 +1,12 @@ # coding: utf-8 Gem::Specification.new do |spec| - spec.name = "jekyll-rss-feed" + spec.name = "jekyll-feed" spec.version = "0.0.1" spec.authors = ["Ben Balter"] spec.email = ["ben.balter@github.com"] - spec.summary = "A Jekyll plugin to generate an RSS feed for your Jekyll posts" - spec.homepage = "https://github.com/jekyll/jekyll-rss-feed" + spec.summary = "A Jekyll plugin to generate an Atom feed of your Jekyll posts" + spec.homepage = "https://github.com/jekyll/jekyll-feed" spec.license = "MIT" spec.files = `git ls-files -z`.split("\x0") diff --git a/lib/jekyll-rss-feed.rb b/lib/jekyll-feed.rb similarity index 98% rename from lib/jekyll-rss-feed.rb rename to lib/jekyll-feed.rb index 42004986..855e532d 100644 --- a/lib/jekyll-rss-feed.rb +++ b/lib/jekyll-feed.rb @@ -26,7 +26,7 @@ def render(context) end end - class JekyllRssFeed < Jekyll::Generator + class JekyllFeed < Jekyll::Generator safe true priority :lowest diff --git a/script/cibuild b/script/cibuild index 505bb52d..eb5f86b3 100755 --- a/script/cibuild +++ b/script/cibuild @@ -1,4 +1,4 @@ #! /bin/bash bundle exec rspec -gem build jekyll-rss-feed.gemspec +gem build jekyll-feed.gemspec diff --git a/spec/jekyll-rss-feed_spec.rb b/spec/jekyll-feed_spec.rb similarity index 99% rename from spec/jekyll-rss-feed_spec.rb rename to spec/jekyll-feed_spec.rb index 69ff7a54..065578e9 100644 --- a/spec/jekyll-rss-feed_spec.rb +++ b/spec/jekyll-feed_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -describe(Jekyll::JekyllRssFeed) do +describe(Jekyll::JekyllFeed) do let(:overrides) do { "source" => source_dir, diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index f3edd12c..d0b18930 100644 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -2,7 +2,7 @@ require 'typhoeus' require 'nokogiri' require 'rss' -require File.expand_path('../lib/jekyll-rss-feed', File.dirname(__FILE__)) +require File.expand_path('../lib/jekyll-feed', File.dirname(__FILE__)) Jekyll.logger.log_level = :error