aboutsummaryrefslogtreecommitdiff
path: root/Readme.textile
diff options
context:
space:
mode:
authorNat Lasseter <Nat Lasseter nathan@bytemark.co.uk>2019-01-21 11:49:22 +0000
committerNat Lasseter <Nat Lasseter nathan@bytemark.co.uk>2019-01-21 11:49:22 +0000
commit4cd2e8faf6a22a3a42e1969c49eedaec2182ce79 (patch)
treee9bf30e053881c9c3136afdf33515003e8e2285c /Readme.textile
parentec0d9e648ffb826814b232c960fd76c00598eee6 (diff)
Changed drum rolls to be more useful. Added Drum Sticks as a way of doing entrypoint in a semi-clever way. General tidying. Should have committed more often.
Diffstat (limited to 'Readme.textile')
-rw-r--r--Readme.textile31
1 files changed, 26 insertions, 5 deletions
diff --git a/Readme.textile b/Readme.textile
index da469eb..18e4a6e 100644
--- a/Readme.textile
+++ b/Readme.textile
@@ -25,15 +25,36 @@ p. A Kick Drum is a Bass Drum with your gems installed.
bc. drum kick
+h2. Drum Rolls
+
+p. This beats on the Kick Drum with your current directory mounted as a volume. For dev.
+
+bc.. drum roll
+drum roll -- -p123:456
+
h2. Snare Drums
-p. A Snare Drum is a Kick Drum with your application installed.
+p. A Snare Drum is a Kick Drum with your application fully installed, ready for deployment to production.
bc. drum snare
-h2. Drum Rolls
+h2. Drum Stick
-p. This runs the container.
+p. A Drum Stick is how you beat on the Drum. You needn't actually specify the Drum Stick, drum tries to be clever.
-bc.. drum roll
-drum roll -- -p123:456
+h3. Stick selection
+
+p. Drum will try the following sticks in order, and use the first that matches.
+
+# Is there a manually specified stick?
+# Is it a rails app? (Run rails server)
+# Is there an executable file with the same name as the working directory?
+# Is there only one executable .rb file?
+# Is there only one file that looks like "entrypoint"
+# Is there only one executable file?
+
+h3. Manual Stick
+
+bc. drum stick ./example.rb
+drum stick ruby example.rb
+drum stick rails server