[DRE-commits] [ruby-org] 287/303: Update README

[Jérémy Bobbio]

This is an automated email from the git hooks/post-receive script.

lunar pushed a commit to branch master
in repository ruby-org.

commit f60e529cf2c7e2713c6f1cb22243a1f2ae349b1b
Author: Waldemar Quevedo <waldemar.quevedo at gmail.com>
Date:   Sun Feb 10 21:21:14 2013 +0900

    Update README
---
 README.rdoc |  106 +++++++++++++++++++++++++++++++----------------------------
 1 file changed, 55 insertions(+), 51 deletions(-)

diff --git a/README.rdoc b/README.rdoc
index df2e816..3fda0af 100644
--- a/README.rdoc
+++ b/README.rdoc
@@ -1,68 +1,72 @@
-org-ruby
-    by Brian Dewey
-    http://github.com/bdewey/org-ruby
+= org-ruby
+<em>Originally by Brian Dewey</em> (http://github.com/bdewey/org-ruby)
 
-== DESCRIPTION:
+{<img src="https://secure.travis-ci.org/wallyqs/org-ruby.png?branch=master" alt="Build Status" />}[http://travis-ci.org/wallyqs/org-ruby]
 
-This gem contains Ruby routines for parsing org-mode files.The most
-significant thing this library does today is convert org-mode files to
-HTML or textile. Currently, you cannot do much to customize the
-conversion. The supplied textile conversion is optimized for
-extracting "content" from the orgfile as opposed to "metadata." 
+An {org-mode}[http://orgmode.org] parser written in Ruby. The most significant thing this library does today is convert org-mode files to HTML or Textile.
+Currently, you cannot do much to customize the conversion. The supplied textile conversion is optimized for extracting 
+“content” from the orgfile as opposed to “metadata.”
 
-== FEATURES/PROBLEMS:
+== Installation
 
-* Converts org-mode files to HTML or Textile
-* Supports tables, block quotes, and block code
-* Supports bold, italic, underline, strikethrough, and code inline formatting.
-* Supports hyperlinks that are in double-brackets
-* Supports +.org+ views in Rails through Tilt.
-* Code syntax highlight of code blocks using Pygments.rb or Coderay when available
-* Upcoming: Handle export options specified in the org buffer.
-
-== SYNOPSIS:
-
-From the command line:
-
-     org-ruby sample.org
-
-...will output a HTML version of sample.org.
-
-     org-ruby --translate textile sample.org
+     gem install org-ruby
 
-...will output a textile version of sample.org.
+== Usage
 
 From Ruby code:
 
-     Orgmode::Parser.new(data)
+     require 'org-ruby'
+
+     # Renders HTML
+     Orgmode::Parser.new("* Hello world!).to_html
+     # => "<h1>Hello world!</h1>\n"
 
-...will construct a new +Parser+ object.
+     # Renders Textile
+     Orgmode::Parser.new("* Hello world!).to_textile
+     # => "h1. Hello world!\n" 
 
-== INSTALL:
+It can also be used from the command line:
 
-sudo gem install org-ruby
+     org-ruby sample.org --translate html
 
-== LICENSE:
+...will output a HTML version of sample.org.
 
-(The MIT License)
+     org-ruby --translate textile sample.org
 
-Copyright (c) 2009 Brian Dewey
+...will output a textile version of sample.org.
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+== Features
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+* Converts org-mode files to HTML or Textile
+* Supports tables, block quotes, code blocks, and html blocks
+* Supports bold, italic, underline, strikethrough, and code inline formatting.
+* Supports hyperlinks that are in double-brackets
+* Supports definition lists
+* Supports footnotes
+* Supports +.org+ views in Rails through Tilt.
+* Code syntax highlight of code blocks using Pygments.rb or Coderay when available
 
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+== License
+
+ (The MIT License)
+
+ Copyright (c) 2009 Brian Dewey
+
+ Permission is hereby granted, free of charge, to any person obtaining
+ a copy of this software and associated documentation files (the
+ 'Software'), to deal in the Software without restriction, including
+ without limitation the rights to use, copy, modify, merge, publish,
+ distribute, sublicense, and/or sell copies of the Software, and to
+ permit persons to whom the Software is furnished to do so, subject to
+ the following conditions:
+ 
+ The above copyright notice and this permission notice shall be
+ included in all copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+ CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+ TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-ruby-extras/ruby-org.git