summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBruno P. Kinoshita <kinow@users.noreply.github.com>2016-12-17 09:55:44 +1300
committerGitHub <noreply@github.com>2016-12-17 09:55:44 +1300
commitb40872c74aaa2cda856cd16c1e80ec2d21417f68 (patch)
treea3e2ebcbd7e777060fef3b50c71df4b3a5083cb4
parent953e16c254d8108167e391cc2104b9dffc725536 (diff)
Update README adding mailing list
Note about mailing list, GitHub issues, and also move both under a Community section, and move it before the Installation (now a section in Markdown too)
-rw-r--r--README.md8
1 files changed, 6 insertions, 2 deletions
diff --git a/README.md b/README.md
index 87b3a47..169a09d 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,11 @@
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/SmashingDashboard/smashing). For more general questions, or help with widgets, please use the [project mailing list](https://groups.google.com/forum/#!forum/smashing-dashboard).
+
+## Installation
```bash
# Install bundler
@@ -23,5 +27,5 @@ $ smashing start
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).