diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 28 |
1 files changed, 23 insertions, 5 deletions
@@ -1,9 +1,27 @@ -# [Dashing](http://shopify.github.com/dashing) - +# [Smashing](https://github.com/dashing-io/smashing/wiki) -Dashing is a Sinatra based framework that lets you build beautiful 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. -[Check out the homepage](http://shopify.github.com/dashing). +**Installation**: + +```bash +# Install bundler +$ gem install bundler +# Install smashing +$ gem install smashing +# Create a new project +$ smashing new my-project +# 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/SmashingDashboard/smashing/wiki). + +Note: This is a fork of the Dashing project, which is no longer being maintained. Read about that [here](https://github.com/Shopify/dashing/issues/711). # License -Distributed under the [MIT license](https://github.com/Shopify/dashing/blob/master/MIT-LICENSE) +Distributed under the [MIT license](MIT-LICENSE). |