summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTyler Mauthe <me@tylermauthe.com>2016-11-19 13:00:20 -0800
committerGitHub <noreply@github.com>2016-11-19 13:00:20 -0800
commitf08bbc16148a6eecf0c0166ce95cbdf956306209 (patch)
treef810917b48552a836755a96e86d685859b35668a /README.md
parentd894368bbf08b896703e392071932eb3b9980bc9 (diff)
Update README.md
Further clarification of installation and new project instructions.
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 9 insertions, 7 deletions
diff --git a/README.md b/README.md
index fbf50a4..7458a0a 100644
--- a/README.md
+++ b/README.md
@@ -5,16 +5,18 @@ Smashing, the spiritual successor to [Dashing](https://github.com/Shopify/dashin
**Installation**:
```bash
+# Install bundler
$ gem install bundler
-Fetching: bundler-X.X.X.gem (100%)
-# <snip>
+# Install smashing
$ gem install smashing
-Fetching: smashing-1.0.0.gem (100%)
-# <snip>
+# Create a new project
$ smashing new my-project
-create my-project
-create my-project/.gitignore
-# <snip>
+# Change Directory into the project
+$ cd my-project
+# Install the bundle of project specific gems
+$ bundle
+# Start the example dashboard!
+$ smashing start
```
[Check out our wiki](https://github.com/dashing-io/smashing/wiki).