Skip to content

Commit

Permalink
update documentation, v0.1.2
Browse files Browse the repository at this point in the history
  • Loading branch information
vast committed Apr 20, 2012
1 parent ea0b7e8 commit d841d89
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 1 deletion.
4 changes: 4 additions & 0 deletions README.md
Expand Up @@ -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:
Expand Down
1 change: 1 addition & 0 deletions lib/rokko/layout.rb
@@ -1,4 +1,5 @@
require 'pathname'

module Rokko
class Layout < Mustache
self.template_path = File.dirname(__FILE__)
Expand Down
14 changes: 14 additions & 0 deletions 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
Expand Down
2 changes: 1 addition & 1 deletion 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.