readme and version bump
This commit is contained in:
parent
06d175b525
commit
c8123de14b
4 changed files with 28 additions and 21 deletions
41
README.md
Normal file
41
README.md
Normal file
|
@ -0,0 +1,41 @@
|
|||
# Microformats
|
||||
|
||||
http://github.com/veganstraightedge/microformats2
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
Generic Microformats 2 Extractor
|
||||
|
||||
## FEATURES/PROBLEMS
|
||||
|
||||
* parses and extracts [Microformats 2](http://microformats.org/wiki/microformats-2) syntax
|
||||
* needs more test cases
|
||||
* needs better docs
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
Microformats2.parse(File.open("example.html"))
|
||||
|
||||
## REQUIREMENTS
|
||||
|
||||
* Hoe
|
||||
* Nokogiri
|
||||
|
||||
## INSTALL
|
||||
|
||||
sudo gem install microformats2
|
||||
|
||||
## DEVELOPERS
|
||||
|
||||
After checking out the source, run:
|
||||
|
||||
rake newb
|
||||
|
||||
This task will install any missing dependencies,
|
||||
run the tests/specs, and generate the RDoc.
|
||||
|
||||
## LICENSE
|
||||
|
||||
**PUBLIC DOMAIN.**
|
||||
Your heart is as free as the air you breathe.
|
||||
The ground you stand on is liberated territory.
|
Loading…
Add table
Add a link
Reference in a new issue