summaryrefslogtreecommitdiff
path: root/README.markdown
diff options
context:
space:
mode:
authorKornelius Kalnbach <murphy@rubychan.de>2013-03-10 20:55:13 +0100
committerKornelius Kalnbach <murphy@rubychan.de>2013-03-10 20:55:13 +0100
commit0d2d0bef962d27abb0b6d7423bce6010bb71976c (patch)
tree50e35275c54a0d78d18febf19ab5e0cf949bccce /README.markdown
parent61d1a15a5be9ecd546e3252691349136e04d86ac (diff)
downloadcoderay-0d2d0bef962d27abb0b6d7423bce6010bb71976c.tar.gz
convert README to markdown, use syntax highlighting, cleanup
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown27
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/).