summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 10 insertions, 4 deletions
diff --git a/README.md b/README.md
index 7458a0a..6ff4065 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,14 @@
-# [Smashing](https://github.com/dashing-io/smashing/wiki)
+[![Gitter chat](https://badges.gitter.im/smashing.png)](https://gitter.im/Smashing)
+
+# [Smashing](https://github.com/Smashing/smashing/wiki)
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**:
+## Community
+
+Feel free to submit issues for bugs, new features, and enhancements in [GitHub](https://github.com/Smashing/smashing/issues). For more general questions, or help with widgets, please use the [gitter chatroom](https://gitter.im/Smashing).
+
+## Installation
```bash
# Install bundler
@@ -19,9 +25,9 @@ $ bundle
$ smashing start
```
-[Check out our wiki](https://github.com/dashing-io/smashing/wiki).
+[Check out our wiki](https://github.com/Smashing/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
+## License
Distributed under the [MIT license](MIT-LICENSE).