README.md in html2rss-0.2.2 vs README.md in html2rss-0.3.0
- old
+ new
@@ -1,63 +1,49 @@
-# html2rss [](https://travis-ci.org/gildesmarais/html2rss)
+# html2rss [](https://travis-ci.org/gildesmarais/html2rss) [](https://badge.fury.io/rb/html2rss)
-Request and convert an HTML document to an RSS feed via a config object.
-The config contains the URL to scrape and the selectors needed to extract
-the required information. This gem provides some extractors (e.g. extract
-the information from an HTML attribute).
+Request HTML from an URL and transform it to a Ruby RSS 2.0 object.
-Please always check the website's Terms of Service before if its allowed to
-scrape their content!
+**Are you searching for a ready to use "website to RSS" solution?**
+[Check out `html2rss-web`!](https://github.com/gildesmarais/html2rss-web)
+Each website needs a feed config which contains the URL to scrape and
+CSS selectors to extract the required information (like title, URL, ...).
+This gem provides [extractors](https://github.com/gildesmarais/html2rss/blob/master/lib/html2rss/item_extractor.rb) (e.g. extract the information from an HTML attribute)
+and [post processors](https://github.com/gildesmarais/html2rss/tree/master/lib/html2rss/attribute_post_processors) to make information retrieval even easier.
+
## Installation
-Add this line to your application's Gemfile:
+Add this line to your application's Gemfile: `gem 'html2rss'`
+And then execute: `bundle`
-```ruby
-gem 'html2rss'
-```
+## Usage with a YAML config file
-And then execute:
-
- $ bundle
-
-Or install it yourself as:
-
- $ gem install html2rss
-
-## Usage
-
-## Usage with a YAML file
-
Create a YAML config file. Find an example at [`rspec/config.test.yml`](https://github.com/gildesmarais/html2rss/blob/master/spec/config.test.yml).
`Html2rss.feed_from_yaml_config(File.join(['spec', 'config.test.yml']), 'nuxt-releases')` returns
an `RSS:Rss` object.
-## Usage in a web application
+**Too complicated?** See [`html2rss-configs`](https://github.com/gildesmarais/html2rss-configs) for ready-made feed configs!
-Find a minimal Sintra app which exposes your feeds to HTTP endpoints here:
-[gildesmarais/html2rss-web](https://github.com/gildesmarais/html2rss-web)
-
-### Tips and tricks
-
-- Check that the channel url does not redirect to a mobile page
-- fiddling with [`curl`](https://github.com/curl/curl) and [`pup`](https://github.com/ericchiang/pup) to find the selectors seems quite efficient
-
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/gildesmarais/html2rss.
-## Changelog generation
+## Releasing a new version
-The `CHANGELOG.md` can be generated automatically with [`standard-changelog`](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/standard-changelog).
+1. increase version in `lib/version.rb`
+2. `bundle`
+3. commit the changes
+4. `git tag v....`
+5. `git push; git push --tags`
+6. update the changelog, commit and push
-## License
+### Changelog generation
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The `CHANGELOG.md` can be generated automatically with [`standard-changelog`](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/standard-changelog).