diff --git a/README.md b/README.md index 70983f2..947ffc2 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,19 @@ # Microformats2 -TODO: Write a gem description +A Ruby gem to parse HTML containing one or more +[microformats2](http://microformats.org/wiki/microformats-2), +returning an a collection of Ruby objects. + +## Current Version + +0.0.1 + + +## Requirements + +* "nokogiri", "~> 1.5.6" +* "json", "~> 1.7.6" + ## Installation @@ -16,17 +29,36 @@ Or install it yourself as: $ gem install microformats2 + ## Usage -TODO: Write usage instructions here +```ruby +require "microformats2" -## Contributing +html = '

G5

"G5" +``` + + +## Authors + +* Jessica Lynn Suttles / [@jlsuttles](https://github.com/jlsuttles) + + +## Contributions 1. Fork it -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`) -5. Create new Pull Request +2. Get it running (see Installation above) +3. Create your feature branch (`git checkout -b my-new-feature`) +4. Write your code and **specs** +5. Commit your changes (`git commit -am 'Add some feature'`) +6. Push to the branch (`git push origin my-new-feature`) +7. Create new Pull Request + +If you find bugs, have feature requests or questions, please +[file an issue](https://github.com/G5/microformats2/issues). + ## License