Merge branch 'master' into lua-scanner

1 files changed, 27 insertions, 0 deletions

diff --git a/README.markdown b/README.markdown
new file mode 100644
index 0000000..42bdab6
--- /dev/null
+++ b/README.markdown
@@ -0,0 +1,27 @@
+# CodeRay [![Build Status](https://travis-ci.org/rubychan/coderay.png)](https://travis-ci.org/rubychan/coderay)
+
+## About
+
+CodeRay is a Ruby library for syntax highlighting.
+
+You put your code in, and you get it back colored; Keywords, strings, floats, comments - all in different colors. And with line numbers.
+
+## Installation
+
+`gem install coderay`
+
+### Dependencies
+
+CodeRay needs Ruby 1.8.7+ or 1.9.2+. It also runs on Rubinius and JRuby.
+
+## Example Usage
+
+```ruby
+require 'coderay'
+
+html = CodeRay.scan("puts 'Hello, world!'", :ruby).div(:line_numbers => :table)
+````
+
+## Documentation
+
+See [http://coderay.rubychan.de/doc/](http://coderay.rubychan.de/doc/).