summaryrefslogtreecommitdiff
path: root/README.markdown
diff options
context:
space:
mode:
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown31
1 files changed, 31 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown
new file mode 100644
index 0000000..f333655
--- /dev/null
+++ b/README.markdown
@@ -0,0 +1,31 @@
+# CodeRay
+
+[![Build Status](https://travis-ci.org/rubychan/coderay.png)](https://travis-ci.org/rubychan/coderay)
+[![Gem Version](https://badge.fury.io/rb/coderay.png)](http://badge.fury.io/rb/coderay)
+[![Dependency Status](https://gemnasium.com/rubychan/coderay.png)](https://gemnasium.com/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, 1.9.3 or 2.0. It also runs on 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/).