simple_discussion 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea112341c29ae6d453a260175e1fab4fe8742243
-  data.tar.gz: '08670316d53d01df1dfc1f0101d59f43e46be643'
+  metadata.gz: 04550c334662cad9d3c499d5491d11c72926c821
+  data.tar.gz: 2c4297ad07399e4fafb916cae5fe464a2e566fa8
 SHA512:
-  metadata.gz: 87914991332ab15ab141c77baf1924fc8c89b4f4e01c1fc9121eff52309daa4a23c1310833db545750d25dc82dd9c8805647ff834147d7fca3ed1da96d336390
-  data.tar.gz: fde66ad800d05ea86cf1251950f490f2d221d10b8e8807d67863c41f022a54a713391e0e10148a7ea9ede736276dcba5d03a92babd0f1c66fa1b45f084332846
+  metadata.gz: 7157df980c2e77655d0d567dd11f3623944934ee9aeddd13694e1985cdbcc79a37cede6daeb00f7bbe0c2f79df472c8ad03ee42051b2f86b8fdbe337a85610d7
+  data.tar.gz: 8cf33b46566b4d7a032540ae5adfc6fb69be64484b8fead0b2ffc186ac6a381aaf9c04b0088ae8bf025d9918f4342aac8eb0bf010f014643c583f8e9f2dc4e2e

data/README.md

@@ -1,8 +1,8 @@
 # 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
 
@@ -66,7 +66,29 @@ To get all the basic functionality, the only thing you need to do is add a link
 <%= 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
 

data/lib/generators/simple_discussion/controllers_generator.rb

@@ -0,0 +1,13 @@
+require 'rails/generators'
+
+module SimpleDiscussion
+  module Generators
+    class ControllersGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../../..", __FILE__)
+
+      def copy_controllers
+        directory 'app/controllers/simple_discussion', 'app/controllers/simple_discussion'
+      end
+    end
+  end
+end

data/lib/generators/simple_discussion/helpers_generator.rb

@@ -0,0 +1,13 @@
+require 'rails/generators'
+
+module SimpleDiscussion
+  module Generators
+    class HelpersGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../../..", __FILE__)
+
+      def copy_views
+        directory 'app/helpers', 'app/helpers'
+      end
+    end
+  end
+end

data/lib/generators/simple_discussion/views_generator.rb

@@ -0,0 +1,13 @@
+require 'rails/generators'
+
+module SimpleDiscussion
+  module Generators
+    class ViewsGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../../..", __FILE__)
+
+      def copy_views
+        directory 'app/views', 'app/views'
+      end
+    end
+  end
+end

data/lib/simple_discussion/version.rb

@@ -1,3 +1,3 @@
 module SimpleDiscussion
-  VERSION = "0.9.0"
+  VERSION = "0.9.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_discussion
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Chris Oliver
@@ -124,6 +124,9 @@ files:
 - db/migrate/20170417012931_create_forum_threads.rb
 - db/migrate/20170417012932_create_forum_posts.rb
 - db/migrate/20170417012933_create_forum_subscriptions.rb
+- lib/generators/simple_discussion/controllers_generator.rb
+- lib/generators/simple_discussion/helpers_generator.rb
+- lib/generators/simple_discussion/views_generator.rb
 - lib/simple_discussion.rb
 - lib/simple_discussion/engine.rb
 - lib/simple_discussion/forum_user.rb