soaring 0.1.8 → 0.1.9

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +18 -1
  3. data/lib/soaring/version.rb +1 -1
  4. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 8f128fd86325ba8da2b3b0be7b8ddb7cfcf6b90b
4
- data.tar.gz: e618b50f719e867d624f4420fb45baf8da818107
3
+ metadata.gz: 3e51c81c87f78445eb16f7c608554d119ddba80f
4
+ data.tar.gz: 2f420dee5c13092000ee75c4006cd484bb16eb16
5
5
  SHA512:
6
- metadata.gz: 63e19fe18f20b3e7bfabb3ec42484f070fe99607dbb053ad1de46b656145524afff1bce52d0c0ec76d9991a2f5fc9b2ed88b4d85a7fa43787617927a6d907a33
7
- data.tar.gz: 7a8493c649ea95876deb55b34e7c174de68ecfebe99193c1f8484498c7e3deef64996077fcf19b394f22d8947ca5a68dbe893d5b3c5ca172c995cb0a2e3a6171
6
+ metadata.gz: 8caa2e81cad920c040cdaafcd76d4844ea58e4e128a450289829cb93158efc7e5febfb273b0ee2d037c057211bbb3f61efc6657205a026a05bcfb00330573658
7
+ data.tar.gz: e9a2e004dc51f73f38b952310c1a655632bba85950362594fa10fd1ca27d837030bac0a7a1bebd2476d3ab69ef10813e19f9bbdccb0476b09ffd99e6af75d488
data/README.md CHANGED
@@ -5,40 +5,57 @@ This gem provides a collection of command line tools that simplifies the creatio
5
5
  ## Installation
6
6
 
7
7
  Install the gem from rubygems as follow:
8
-
8
+ ```bash
9
9
  gem install soaring
10
+ ```
10
11
 
11
12
  ## Creating a new project
12
13
 
13
14
  Create a repo on github/gitlab, clone locally and enter project folder:
15
+ ```bash
14
16
  git clone git@github.com:hetznerZA/my-awesome-service-component.git
15
17
  cd my-awesome-service-component
18
+ ```
16
19
 
17
20
  Create the fresh project skeleton:
21
+ ```bash
18
22
  soaring init
23
+ ```
19
24
 
20
25
  Switch to the appropriate ruby version and install the gem dependencies:
26
+ ```bash
21
27
  rvm use . && bundle install
28
+ ```
22
29
 
23
30
  Create an environment.yml file by copying the example and updating to your needs:
31
+ ```bash
24
32
  cp config/environment.yml.example config/environment.yml
33
+ ```
25
34
 
26
35
  ## Running a service component locally
27
36
 
28
37
  Start up a local instance of the service component to check that all is well
38
+ ```bash
29
39
  soaring run
40
+ ```
30
41
 
31
42
  This will default to a MRI ruby rack application running with the following defaults:
43
+ ```bash
32
44
  port = 9393
33
45
  environment = 'development'
46
+ ```
34
47
 
35
48
  These defaults can be overriden using parameters passed to soaring. View the command line options:
49
+ ```bash
36
50
  soaring -h
51
+ ```
37
52
 
38
53
  ## Packaging the service component for deployment
39
54
 
40
55
  Make sure your git repo is committed and pushed to master. Execute the following command.
56
+ ```bash
41
57
  soaring package
58
+ ```
42
59
 
43
60
  The output build zip file will be placed in the builds folder.
44
61
 
@@ -1,3 +1,3 @@
1
1
  module Soaring
2
- VERSION = "0.1.8"
2
+ VERSION = "0.1.9"
3
3
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: soaring
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.8
4
+ version: 0.1.9
5
5
  platform: ruby
6
6
  authors:
7
7
  - Barney de Villiers