README.md in soaring-0.1.1 vs README.md in soaring-0.1.2
- old
+ new
@@ -8,26 +8,33 @@
gem install soaring
## Creating a new project
+Create a repo on github/gitlab, clone locally and enter project folder:
+ git clone git@github.com:hetznerZA/my-awesome-service-component.git
+ cd my-awesome-service-component
+
Create the fresh project skeleton:
soaring init
-Switch to the appropriate ruby version and install the gem dependencies
+Switch to the appropriate ruby version and install the gem dependencies:
rvm use . && bundle install
-Create an environment.yml file by copying the example:
+Create an environment.yml file by copying the example and updating to your needs:
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
-This will default to a MRI ruby rack application running with the following defaults that can be specified
+This will default to a MRI ruby rack application running with the following defaults:
port = 9393
environment = 'development'
+
+These defaults can be overriden using parameters passed to soaring. View the command line options:
+ soaring -h
## Packaging the service component for deployment
Make sure your git repo is committed and pushed to master. Execute the following command.
soaring package