diff options
| author | Kornelius Kalnbach <murphy@rubychan.de> | 2013-03-10 20:55:13 +0100 |
|---|---|---|
| committer | Kornelius Kalnbach <murphy@rubychan.de> | 2013-03-10 20:55:13 +0100 |
| commit | 0d2d0bef962d27abb0b6d7423bce6010bb71976c (patch) | |
| tree | 50e35275c54a0d78d18febf19ab5e0cf949bccce | |
| parent | 61d1a15a5be9ecd546e3252691349136e04d86ac (diff) | |
| download | coderay-0d2d0bef962d27abb0b6d7423bce6010bb71976c.tar.gz | |
convert README to markdown, use syntax highlighting, cleanup
| -rw-r--r-- | README.markdown | 27 | ||||
| -rw-r--r-- | README.textile | 37 |
2 files changed, 27 insertions, 37 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 [](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/). diff --git a/README.textile b/README.textile deleted file mode 100644 index b44899c..0000000 --- a/README.textile +++ /dev/null @@ -1,37 +0,0 @@ -h1. CodeRay !https://api.travis-ci.org/rubychan/coderay.png!:https://travis-ci.org/rubychan/coderay - -h2. 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. - -*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 wants to have on their website -* solves all your problems and makes the girls run after you - - -h2. Installation - -bc. gem install coderay - -h3. Dependencies - -CodeRay needs Ruby 1.8.7+ or 1.9.2+. It also runs on Rubinius and JRuby. - -h2. Example Usage - -bc.. require 'coderay' - -html = CodeRay.scan("puts 'Hello, world!'", :ruby).div(:line_numbers => :table) - -p. - -h2. Documentation - -See "http://coderay.rubychan.de/doc/":http://coderay.rubychan.de/doc/. |