updates README
This commit is contained in:
parent
c013f48a03
commit
6f34f070a8
1 changed files with 39 additions and 7 deletions
46
README.md
46
README.md
|
@ -1,6 +1,19 @@
|
||||||
# Microformats2
|
# 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
|
## Installation
|
||||||
|
|
||||||
|
@ -16,17 +29,36 @@ Or install it yourself as:
|
||||||
|
|
||||||
$ gem install microformats2
|
$ gem install microformats2
|
||||||
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
TODO: Write usage instructions here
|
```ruby
|
||||||
|
require "microformats2"
|
||||||
|
|
||||||
## Contributing
|
html = '<div class="h-org"><p class="p-name">G5</p></div'
|
||||||
|
formats = Microformats.parse(html)
|
||||||
|
puts format.h_org.name.value # => "G5"
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
## Authors
|
||||||
|
|
||||||
|
* Jessica Lynn Suttles / [@jlsuttles](https://github.com/jlsuttles)
|
||||||
|
|
||||||
|
|
||||||
|
## Contributions
|
||||||
|
|
||||||
1. Fork it
|
1. Fork it
|
||||||
2. Create your feature branch (`git checkout -b my-new-feature`)
|
2. Get it running (see Installation above)
|
||||||
3. Commit your changes (`git commit -am 'Add some feature'`)
|
3. Create your feature branch (`git checkout -b my-new-feature`)
|
||||||
4. Push to the branch (`git push origin my-new-feature`)
|
4. Write your code and **specs**
|
||||||
5. Create new Pull Request
|
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
|
## License
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue