README.md in docparser-0.0.1 vs README.md in docparser-0.1.0
- old
+ new
@@ -1,23 +1,29 @@
# DocParser
-Docs: http://rubydoc.info/github/jurriaan/docparser/
+[](https://travis-ci.org/jurriaan/docparser)
DocParser is a web scraping/screen scraping tool.
+
You can use it to easily scrape web sites.
+The gem is called [docparser](http://rubygems.org/gems/docparser).
+You can find the documentation [here](http://rubydoc.info/github/jurriaan/docparser/).
+
## Features
- XPath and CSS support through Nokogiri
- Support for loading of URLs throug open-uri
- Support for parallel processing of the documents
-- 5 Output formats:
+- 6 Output formats:
* CSV
* XLSX
* HTML
* YAML
+ * JSON
* Screen (for debugging and development)
+ * And more! (easy to extend)
## Installation
Add this line to your application's Gemfile:
@@ -31,15 +37,16 @@
$ gem install docparser
## Usage
-See example.rb
+See [example.rb](https://github.com/jurriaan/docparser/blob/master/example.rb)
## Todo
- Tests
+- Better examples
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
@@ -47,6 +54,6 @@
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
## Contributors
-- Jurriaan Pruis
\ No newline at end of file
+- [Jurriaan Pruis](https://github.com/jurriaan)