README.md in forj-0.0.29 vs README.md in forj-0.0.30
- old
+ new
@@ -1,17 +1,62 @@
Forj cli
=====================
-How to use it
+Installation
=====================
+For ruby 1.9
+ sudo apt-get install ruby-dev build-essential libopenssl-ruby1.9.1 libssl-dev zlib1g-dev -y
+ sudo gem install forj
+For ruby 1.8
+
+ sudo apt-get install ruby1.8-dev ruby1.8 ri1.8 rdoc1.8 irb1.8 -y
+ sudo apt-get install libreadline-ruby1.8 libruby1.8 libopenssl-ruby -y
+ sudo apt-get install libxslt-dev libxml2-dev -y
+ sudo gem install nokogiri
+ sudo apt-get install ruby-bundler -y
+ sudo gem install mime-types -v 1.25.1
+ sudo gem install hpcloud
+ sudo gem install forj
+
+
+How to use forj cli
+=====================
+Setup forj
+
+ forj setup # follow the instructions
+
+Boot a forge
+
+ forj boot <blueprint> on <cloud_provider> as <name>
+ e.g. forj boot redstone on hpcloud as maestro_01
+
+Optional arguments
+
+ -u --build #Replace the default build.sh.
+ -d --build_config_dir # Defines the build configuration directory to load the build configuration file.
+ -c --build_config # The build config file to load <confdir>/<BoxName>.<Config>.env.
+ -b --branch # The build will extract from git branch name.
+ -t --test_box # Create test-box meta from the repository path provided.
+ -r --git_repo # The box built will use a different git repository sent out to <user_data>.
+ -h --boothook # By default, boothook file used is build/bin/build-tools/boothook.sh.
+ -x --box_name # Defines the name of the box or box image to build.
+ -k --key_name # Key pair name to import.
+ -p --key_path # Public key pair data.
+
+To ssh into a server
+
+ forj ssh <name> <node>
+ e.g. forj ssh maestro_01 [maestro, ci, util, review] # the nodes from your blueprint
+
+
Contributing to Forj
=====================
We welcome all types of contributions. Checkout our website (http://docs.forj.io/en/latest/dev/contribute.html)
to start hacking on Forj. Also join us in our community (https://www.forj.io/community/) to help grow and foster Forj for
your development today!
License
=====================
-forj cli is licensed under the Apache License, Version 2.0. See LICENSE for full license text.
+Forj Cli is licensed under the Apache License, Version 2.0. See LICENSE for full license text.
\ No newline at end of file