README.mkd in ruby-gumbo-1.0.2 vs README.mkd in ruby-gumbo-1.1.0
- old
+ new
@@ -1,48 +1,45 @@
# ruby-gumbo
-## Description
+Ruby bindings for Google's [Gumbo][gumbo] HTML5
+parser.
-`ruby-gumbo` is a ruby binding for the Gumbo HTML5 parser.
-## Installation
+## Getting Started
-`ruby-gumbo` can be directly installed from http://rubygems.org:
+Stick it in your `Gemfile`!
- gem install ruby-gumbo
+```ruby
+gem 'ruby-gumbo', '~> 1.1'
+```
-Or you can create the gem with `rake package`, then install it with `gem
-install` (the gem file is in the `pkg` directory).
+And then parse away:
-## Example
-
```ruby
-require 'net/http'
-
-html = Net::HTTP.get URI.parse('http://example.org')
-Gumbo::parse(html) {|doc| doc.dump_tree}
+require 'gumbo'
+doc = Gumbo::parse(html)
```
-Result:
+You'll probably want to peruse the [documentation][docs] to see how to navigate
+a document and its nodes.
+
+## Developing
+
+Grab the repository, and make sure to include submodules:
+
```
-<HTML>
- <HEAD>
- <TITLE>
- <META charset>
- <META http-equiv content>
- <META name content>
- <STYLE type>
- <BODY>
- <DIV>
- <H1>
- <P>
- <P>
- <A href>
+git checkout https://github.com/nevir/ruby-gumbo --recursive
```
-You can find more examples in the `examples` directory.
+And from there you should be able to `rake build` and `gem install pkg/*.gem`.
-## Contact
-If you have found a bug, have an idea or a question, email me at
-<khaelin@gmail.com>.
+## License
+
+ruby-gumbo is licensed under the [ISC license](LICENSE), and packages the
+[gumbo-parser library][gumbo] (APACHE v2.0).
+
+This is not a Google product and is not supported by Google in any way.
+
+[gumbo]: https://github.com/google/gumbo-parser
+[docs]: http://rubydoc.info/github/nevir/ruby-gumbo/master/frames