README.md in soaring-0.0.3 vs README.md in soaring-0.1.0
- old
+ new
@@ -2,25 +2,41 @@
This gem provides a collection of command line tools that simplifies the creation, development and packaging of a soar project for deployment at Hetzner.
## Installation
-Add this line to your application's Gemfile:
+Install the gem from rubygems as follow:
-```ruby
-gem 'soaring'
-```
+ gem install soaring
## Creating a new project
Create the fresh project skeleton:
-$ soaring init
+ soaring init
+Switch to the appropriate ruby version and install the gem dependencies
+ rvm use . && bundle install
+
Create an environment.yml file by copying the example:
-$ cp config/environment.yml.example config/environment.yml
+ cp config/environment.yml.example config/environment.yml
+## Running a service component locally
+
Start up a local instance of the service component to check that all is well
-$ soaring run
+ soaring run
+
+This will default to a MRI ruby rack application running with the following defaults that can be specified
+ port = 9393
+ environment = 'development'
+
+## Packaging the service component for deployment
+
+Make sure your git repo is committed and pushed to master. Execute the following command.
+ soaring package
+
+The output build zip file will be placed in the builds folder.
+
+Note that you can specify the --ignore_git_checks flag if you want to skip the git repo validation
## Contributing
Bug reports and feature requests are welcome by email to barney dot de dot villiers at hetzner dot co dot za. This gem is sponsored by Hetzner (Pty) Ltd (http://hetzner.co.za)