README.md in simple_discussion-0.9.0 vs README.md in simple_discussion-0.9.1
- old
+ new
@@ -1,11 +1,11 @@
# SimpleDiscussion
-SimpleDiscussion is a Rails forum gem extracting the forum from
-[GoRails' forum](https://gorails.com/forum). It includes categories,
-simple moderation, the ability to mark threads as solved, and more.
+SimpleDiscussion is a Rails forum gem extracting the forum from [GoRails' forum](https://gorails.com/forum). It includes categories, simple moderation, the ability to mark threads as solved, and more.
+Out of the box, SimpleDiscussion comes with styling for Boostrap v4 but you're free to customize the UI as much as you like by installing the views and tweaking the HTML.
+
## Installation
Before you get started, SimpleDiscussion requires a `User` model in your application (for now).
Add this line to your application's Gemfile:
@@ -64,10 +64,32 @@
```erb
<%= link_to "Forum", simple_discussion_path %>
```
-This will take the user to the views inside the Rails engine.
+This will take the user to the views inside the Rails engine and that's all you have to do!
+
+### Customizing All The Things!
+
+If you'd like to customize the views that SimpleDiscussion uses, you can install the views to your Rails app:
+
+```bash
+rails g simple_discussion:views
+```
+
+You can also install a copy of the SimpleDiscussion controllers for advanced customization:
+
+```bash
+rails g simple_discussion:controllers
+```
+
+Helpers are available for override as well. They are used for rendering the user avatars, text formatting, and more.
+
+```bash
+rails g simple_discussion:helpers
+```
+
+**NOTE:** Keep in mind that the more customization you do, the tougher gem upgrades will be in the future.
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.