diff --git a/README.md b/README.md new file mode 100644 index 0000000..b8a0033 --- /dev/null +++ b/README.md @@ -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("http://iamshane.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. diff --git a/README.txt b/README.txt deleted file mode 100644 index d408420..0000000 --- a/README.txt +++ /dev/null @@ -1,57 +0,0 @@ -= microformats2 - -* FIX (url) - -== DESCRIPTION: - -FIX (describe your package) - -== FEATURES/PROBLEMS: - -* FIX (list of features or problems) - -== SYNOPSIS: - - FIX (code sample of usage) - -== REQUIREMENTS: - -* FIX (list of requirements) - -== INSTALL: - -* FIX (sudo gem install, anything else) - -== 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: - -(The MIT License) - -Copyright (c) 2011 FIX - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -'Software'), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.