summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorZeger-Jan van de Weg <ZJvandeWeg@users.noreply.github.com>2016-11-18 16:40:33 +0100
committerGitHub <noreply@github.com>2016-11-18 16:40:33 +0100
commite0a6f6f87d7381f329ad0debe7136329d14c1ae4 (patch)
tree447879eb232d8eb0cf56e6b7e7e69eab8f4943c4 /README.md
parentc55edd708398a40c9f8720ee560073462543de61 (diff)
More precise install instructions
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 13 insertions, 2 deletions
diff --git a/README.md b/README.md
index 4cad882..fbf50a4 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,21 @@
# [Smashing](https://github.com/dashing-io/smashing/wiki)
-Smashing, the spiritual successor to Dashing, is a Sinatra based framework that lets you build excellent dashboards. It looks especially great on TVs.
+Smashing, the spiritual successor to [Dashing](https://github.com/Shopify/dashing), is a Sinatra based framework that lets you build excellent dashboards. It looks especially great on TVs.
**Installation**:
-`gem install smashing`
+```bash
+$ gem install bundler
+Fetching: bundler-X.X.X.gem (100%)
+# <snip>
+$ gem install smashing
+Fetching: smashing-1.0.0.gem (100%)
+# <snip>
+$ smashing new my-project
+create my-project
+create my-project/.gitignore
+# <snip>
+```
[Check out our wiki](https://github.com/dashing-io/smashing/wiki).