Browse files

update documentation, v0.1.2

  • Loading branch information...
1 parent ea0b7e8 commit d841d89f9dc81e241e5f3549e18fa73755a18f3e @vast committed Apr 20, 2012
Showing with 20 additions and 1 deletion.
  1. +4 −0 README.md
  2. +1 −0 lib/rokko/layout.rb
  3. +14 −0 lib/rokko/task.rb
  4. +1 −1 lib/rokko/version.rb
View
4 README.md
@@ -21,6 +21,10 @@ Install with Rubygems:
sudo gem install rokko
+or Bundler:
+
+ gem 'rokko'
+
##Usage
`rokko` command can be used to generate documentation for a set of Ruby source files:
View
1 lib/rokko/layout.rb
@@ -1,4 +1,5 @@
require 'pathname'
+
module Rokko
class Layout < Mustache
self.template_path = File.dirname(__FILE__)
View
14 lib/rokko/task.rb
@@ -1,3 +1,17 @@
+# Usage:
+#
+# Rokko::Task.new(:task_name, output_dir, filelist, opts)
+#
+# Example:
+# Rokko::Task.new(:rokko, 'docs',
+# ['lib/**/*.rb', 'README.md'],
+# {:index => true, :local => true})
+#
+# Available options:
+#
+# * `:local` -- generate offline-ready documentation.
+# * `:index` -- if value is a file name, then it will be used as an index. If value is `true` then
+# an index file with table of contents will be generated.
require 'rokko'
module Rokko
View
2 lib/rokko/version.rb
@@ -1,3 +1,3 @@
module Rokko
- VERSION = "0.1.1"
+ VERSION = "0.1.2"
end

0 comments on commit d841d89

Please sign in to comment.