summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKornelius Kalnbach <murphy@rubychan.de>2011-07-09 16:32:25 +0200
committerKornelius Kalnbach <murphy@rubychan.de>2011-07-09 16:32:25 +0200
commitaf5fef051d041384910377fcc004b33470175e5c (patch)
tree5e4142d333fa336463dc2abd6968791d041a07b6
parent30ce303d3e3374222fd79ae4d518e69023b15bff (diff)
downloadcoderay-af5fef051d041384910377fcc004b33470175e5c.tar.gz
update README
-rw-r--r--README.rdoc28
1 files changed, 8 insertions, 20 deletions
diff --git a/README.rdoc b/README.rdoc
index 564a9c0..3ae753f 100644
--- a/README.rdoc
+++ b/README.rdoc
@@ -1,57 +1,45 @@
= CodeRay
-[- Tired of blue'n'gray? Try the original version of this documentation on
-coderay.rubychan.de[http://coderay.rubychan.de/doc/] (use Ctrl+Click to open it in its own frame.) -]
+Tired of blue'n'gray? Try the original version of this documentation on
+coderay.rubychan.de[http://coderay.rubychan.de/doc/] :-)
== About
+
CodeRay is a Ruby library for syntax highlighting.
-Syntax highlighting means: You put your code in, and you get it back colored;
-Keywords, strings, floats, comments - all in different colors.
-And with line numbers.
+You put your code in, and you get it back colored; Keywords, strings,
+floats, comments - all in different colors. And with line numbers.
*Syntax* *Highlighting*...
* makes code easier to read and maintain
* lets you detect syntax errors faster
* helps you to understand the syntax of a language
* looks nice
-* is what everybody should have on their website
+* is what everybody wants to have on their website
* solves all your problems and makes the girls run after you
-Version: 0.9.2
-Author:: murphy (Kornelius Kalnbach)
-Contact:: murphy rubychan de
-Website:: coderay.rubychan.de[http://coderay.rubychan.de]
-License:: GNU LGPL; see LICENSE file in the main directory.
== Installation
-You need RubyGems[http://rubyforge.org/frs/?group_id=126].
-
% gem install coderay
=== Dependencies
-CodeRay needs Ruby 1.8.6 or later. It also runs with Ruby 1.9.1+ and JRuby 1.1+.
+CodeRay needs Ruby 1.8.7+ or 1.9.2+. It also runs on Rubinius and JRuby.
== Example Usage
-(Forgive me, but this is not highlighted.)
require 'coderay'
- tokens = CodeRay.scan "puts 'Hello, world!'", :ruby
- page = tokens.html :line_numbers => :inline, :wrap => :page
- puts page
+ html = CodeRay.scan("puts 'Hello, world!'", :ruby).div(:line_numbers => :table)
== Documentation
See CodeRay.
-Please report errors in this documentation to <murphy rubychan de>.
-
== Credits