/magellan-cli

Primary LanguageRubyMIT LicenseMIT

Magellan::Cli

Gem Version Build Status

TODO: Write a gem description

Installation

Add this line to your application's Gemfile:

gem 'magellan-cli'

And then execute:

$ bundle

Or install it yourself as:

$ gem install magellan-cli

Usage

generate reference pages

update references dir in this repository.

bundle exec rake reference

update references dir in devcenter repository

bundle exec rake reference:devcenter

then check the references updated.

After check the pages, you can commit the .md files to magellan-devcenter.github.io repogitory.

Contributing

  1. Fork it ( https://github.com/[my-github-username]/magellan-cli/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request