how_to 1.0.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9de388800a5f30f1b723166da71a7e0e7dbe430
-  data.tar.gz: ca93db5f96e909b59aee265b9d8472d436a675a3
+  metadata.gz: 487fb08406004fec07ae616735af735a7ddbbef1
+  data.tar.gz: fba61b59ae940e3797fb839332663954314ee49b
 SHA512:
-  metadata.gz: 74efc030fc40d55d00d193add0c15a1e00582a9d2a8087d640fff44c98571ee8e363f1614c66ad75306241d03a4cd8dea00d35f20ec2a7812cf56d33e1b67c7c
-  data.tar.gz: b9dbca28de63bbefd6841ddb26d392d8485fd1088b8d0f0c8c69a7db3a4c0b20ca418774fc713889966cb2032bbfcc086d95cd8c2d6b673395de59ac69351afc
+  metadata.gz: 402340133d6ecd612b9120d166e9ca6a8c0c398b08173f2278a770acf0485f0dcfa9fbf537a17e1b04850101a0b226a94557f8bf2aff8095bf4ca0789fceaff0
+  data.tar.gz: 5a8da8beb71f7e99034912626823859f67866c73f1432196f1ec55a716035642f98436fb98a6455a0ac691d30c9529a8cadcff3036a4fd9602e8ff68fb46c833

data/README.rdoc

@@ -1,3 +1,96 @@
 = HowTo
 
-This project rocks and uses MIT-LICENSE.
+Rails engine that makes managing faq/manual easy and simple. Multilingual CMS for managing faq, question/answer, manual etc.
+
+=begin
+{Live Demo}[http://how-to-demo.herokuapp.com]
+
+{Live demo source code}[https://github.com/railscash/how_to_demo]
+=end
+   
+===Usage
+======Include the gem in your Gemfile and bundle to install the gem.
+  ===== For Rails 5
+
+  gem 'how_to', '~> 2.0.0'
+
+  ====== For Rails 3 & 4
+  gem 'how_to', '~> 1.3.1>'
+
+====You may need to add the following gems if you want to use default layout for how_to. See layout customization section for more details
+  
+  gem "jquery-rails"
+  gem 'bootstrap-sass'
+  gem 'sass-rails',   '~> 3.2.5'
+
+
+===== Install the migrations
+  rake how_to:install:migrations
+
+===== Run db migrations
+  rake db:migrate
+
+  
+===== Mount in your application's route
+  mount HowTo::Engine => "/how_to"
+
+===== You can also get the configuration file and overrides by running the config generator.
+  rails g how_to:config
+ 
+Details are documented in config file, so please read the config file carefully.
+
+====== rake db:migrate and visit mounted location, e.g.
+
+  localhost:3000/how_to
+  
+You should see the public page. You should also see two links on head section named sections and contents. if you override the authorization methods (described in later section) make sure you have permissions to access those pages.
+
+===Modules
+Two models are there.
+
+==== Section
+You can have multilevel section. You can consider this as category. Sections are hierarchical, but only leaves are eligible to have contents 
+
+
+==== Content
+You can create content as question/answer or faq under a specific section. If you love rich text editor for content then see the last section of Readme.
+
+
+===== Sample helper methods you may need to define them in your application controller
+
+  def authorize_to_manage_how_to! #you can set the method name in config file
+    redirect_to :root, :notice => t('notifications.admin_section_access_error') unless admin?
+  end
+
+  def allowed_to_view_how_to #you can set the method name in config file
+    redirect_to main_app.root_path, :notice => t('notifications.admin_section_access_error') unless current_user
+  end
+
+  def permitted_to_manage_how_to? #you can set the method name in config file
+    admin?
+  end
+
+
+===== Optionaly you can customise the layout and view page using:
+======this will generate layout and associated partials under views/layouts/how_to/
+  rails g how_to:layout
+  
+  
+  
+======this will generate the public page for faq/manual  under views/how_to/    
+  rails g how_to:view 
+
+
+
+
+=== If you want to use rich text editor to manage your content HowTo uses Mercury gem for it. Just install mercury gem and configure as per your requirements. Visit https://github.com/jejacks0n/mercury for more details
+Then set 
+  config.rich_text_enabled = true
+in initializers/how_to_config.rb file
+
+
+====For any issues feel free to contact with me or use issue tracker. Drop me a line to ahmed2tul@gmail.com 
+
+
+
+This project rocks and uses MIT-LICENSE.

data/lib/how_to/engine.rb

@@ -6,6 +6,5 @@ require 'awesome_nested_set'
 module HowTo
   class Engine < ::Rails::Engine
     isolate_namespace HowTo
-
   end
 end

data/lib/how_to/version.rb

@@ -1,3 +1,3 @@
 module HowTo
-  VERSION = "1.0.3"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: how_to
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 2.0.0
 platform: ruby
 authors:
 - Muntasim Ahmed
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-24 00:00:00.000000000 Z
+date: 2016-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,40 +16,40 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
-  name: globalize
+  name: globalize-r5
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.1.0
 - !ruby/object:Gem::Dependency
   name: awesome_nested_set
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
@@ -200,7 +200,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Rails engine that makes managing faq/manual easy and simple.