Added HISTORY file. Switched README format with GitHub markdown version

HISTORY.md

@@ -0,0 +1,76 @@
+## 0.5.1 (2010-09-30)
+
+* Support relative path links in rdoc
+
+## 0.5.0 (2010-07-07)
+
+* Added creole support
+
+## 0.4.0 (2010-04-23)
+
+* Removed man page support until it's ready.
+
+## 0.3.3 (2010-03-29)
+
+* UTF-8 works with ReST now.
+
+## 0.3.2 (2010-03-25)
+
+* Improved test runner
+* Forgive ReST problems that aren't user errors.
+
+## 0.3.1 (2010-03-22)
+
+* Add .rst.txt extension
+* Fix ASCII encoding error while using print u'\u010c' non-ASCII char and similar.
+
+## 0.3.0 (2010-03-11)
+
+* man rendering
+* `github-markup` command line runner
+
+## 0.2.2 (2010-02-09)
+
+* pod fixes from Ricardo Signes
+
+## 0.2.1 (2010-01-25)
+
+* ReST fixes from Michael Jones
+
+## 0.2.0 (2010-01-10)
+
+* org-mode support
+
+## 0.1.7 (2009-11-17)
+
+* Ditch asciidoc2html, call asciidoc directly
+
+## 0.1.6 (2009-11-17)
+
+* mdown
+
+## 0.1.5 (2009-11-17)
+
+* Actually, if we can't render a thing then don't. Not once, not never.
+
+## 0.1.4 (2009-11-17)
+
+* Bugfix: Missing commands return the input (instead of nothing)
+
+## 0.1.3 (2009-11-02)
+
+* Strip the INDEX comments from POD
+
+## 0.1.2 (2009-11-02)
+
+* Renamed to `github-markup`
+* Bugfix: POD rendering works now, not just index
+
+## 0.1.1 (2009-11-02)
+
+* Added `GitHub::Markup.can_render?` helper.
+* Bugfix: Actually check file extensions
+
+## 0.1.0 (2009-11-02)
+
+* First release

README.md

@@ -0,0 +1,120 @@
+GitHub Markup
+=============
+
+We use this library on GitHub when rendering your README or any other
+rich text file.
+
+Markups
+-------
+
+The following markups are supported.  The dependencies listed are required if
+you wish to run the library.
+
+* [.markdown](http://daringfireball.net/projects/markdown/) -- `gem install rdiscount`
+* [.textile](http://www.textism.com/tools/textile/) -- `gem install RedCloth`
+* [.rdoc](http://rdoc.sourceforge.net/)
+* [.org](http://orgmode.org/) -- `gem install org-ruby`
+* [.creole](http://wikicreole.org/) -- `gem install creole`
+* [.rst](http://docutils.sourceforge.net/rst.html) -- `easy_install docutils`
+* [.asciidoc](http://www.methods.co.nz/asciidoc/) -- `brew install asciidoc`
+* [.pod](http://search.cpan.org/dist/perl/pod/perlpod.pod) -- `Pod::Simple::HTML`
+  comes with Perl >= 5.10. Lower versions should install Pod::Simple from CPAN.
+* .1 - Requires [`groff`](http://www.gnu.org/software/groff/)
+
+
+Contributing
+------------
+
+Want to contribute? Great! There are two ways to add markups.
+
+
+### Commands
+
+If your markup is in a language other than Ruby, drop a translator
+script in `lib/github/commands` which accepts input on STDIN and
+returns HTML on STDOUT. See [rest2html][r2h] for an example.
+
+Once your script is in place, edit `lib/github/markups.rb` and tell
+GitHub Markup about it. Again we look to [rest2html][r2hc] for
+guidance:
+
+    command(:rest2html, /re?st(.txt)?/)
+
+Here we're telling GitHub Markup of the existence of a `rest2html`
+command which should be used for any file ending in `rest`,
+`rst`, `rest.txt` or `rst.txt`. Any regular expression will do.
+
+Finally add your tests. Create a `README.extension` in `test/markups`
+along with a `README.extension.html`. As you may imagine, the
+`README.extension` should be your known input and the
+`README.extension.html` should be the desired output.
+
+Now run the tests: `rake`
+
+If nothing complains, congratulations!
+
+
+### Classes
+
+If your markup can be translated using a Ruby library, that's
+great. Check out Check `lib/github/markups.rb` for some
+examples. Let's look at Markdown:
+
+    markup(:markdown, /md|mkdn?|markdown/) do |content|
+      Markdown.new(content).to_html
+    end
+
+We give the `markup` method three bits of information: the name of the
+file to `require`, a regular expression for extensions to match, and a
+block to run with unformatted markup which should return HTML.
+
+If you need to monkeypatch a RubyGem or something, check out the
+included RDoc example.
+
+Tests should be added in the same manner as described under the
+`Commands` section.
+
+
+Installation
+-----------
+
+    gem install github-markup
+
+
+Usage
+-----
+
+    require 'github/markup'
+    GitHub::Markup.render('README.markdown', "* One\n* Two")
+
+Or, more realistically:
+
+    require 'github/markup'
+    GitHub::Markup.render(file, File.read(file))
+
+
+Testing
+-------
+
+To run the tests:
+
+    $ rake
+
+To add tests see the `Commands` section earlier in this
+README.
+
+
+Contributing
+------------
+
+1. Fork it.
+2. Create a branch (`git checkout -b my_markup`)
+3. Commit your changes (`git commit -am "Added Snarkdown"`)
+4. Push to the branch (`git push origin my_markup`)
+5. Create an [Issue][1] with a link to your branch
+6. Enjoy a refreshing Diet Coke and wait
+
+
+[r2h]: http://github.com/github/markup/tree/master/lib/github/commands/rest2html
+[r2hc]: http://github.com/github/markup/tree/master/lib/github/markups.rb#L13
+[1]: http://github.com/github/markup/issues