beta_invite 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73a29089570d4d67efa3e4998913f2ad58082f39
-  data.tar.gz: 1ddecea397a0543130e942dbbfcb7d5ee8edaf5b
+  metadata.gz: 96d298531b8fa6c1959325ddd159710774b9d14a
+  data.tar.gz: a4c8b5d5cee67cd421e0b6d5ad6e672094de5738
 SHA512:
-  metadata.gz: c7a0eb71dbdbf08f9eb55c28f5eba32c2939676e927e9034da091c3510395b269747a54cee898440ca867b915069e5bc42e3702d53204545b0ba7a4ff7965f3d
-  data.tar.gz: 83a4679ab16728bffa3aa5002a1ddad09b5adde872d6c24b085c37e1d0dc553d4a332484bc13d7a4947e0da818ea600d41284d6bc4681e9a3517eb8f8f6f154e
+  metadata.gz: b6db7a2543d201223766e5acceedb560cab9666a103723e23edfecea80b7aa30757aa85971ccf540f0c08b2dde1ff07771ee678532d641cf5d9a426e4502103e
+  data.tar.gz: 8804d81df686ed652e9d3523b1958468aad6e83680f47c4bbf786a3f27b2a266d3f757afcd79a7c2b7d8c617eef6991941e19b571c58260511cac91f9498a72e

data/README.md

@@ -1,3 +1,69 @@
 #BetaInvite
 
-A simple gem to help you build your __beta_invite__ page up and running in no time
+A simple gem to help you build your __beta_invite__ page up and running in no time
+
+##Instructions
+
+###Installation
+
+```ruby
+gem install beta_invite
+```
+
+or with the use of __Bundler__, you can just write `beta_invite` in your `Gemfile` and run `bundle` command in your CLI.
+
+###Setup
+
+####Migrations
+The setup is very primary as of now. Once installed, you will need to copy the migrations by running this command
+
+```ruby
+rake beta_invite:install:migrations
+```
+
+Run the migrations
+
+```ruby
+rake db:migrate
+```
+
+The above migrations would create a `beta_invites` table in your app
+
+####Mount
+Now mount the `BetaInvite` engine by going into your `routes.rb` file and adding the below line
+
+```ruby
+mount BetaInvite::Engine, at: '/'
+```
+
+####Views
+
+
+You can generate the views that the gem has into your rails app by this below command
+
+```ruby
+rails generate beta_invite:views
+```
+
+___ for version >= 0.1.1 ___
+
+You may wanna upgrade your gem at this point in time
+
+```ruby
+gem update beta_invite
+```
+
+Obviously, you can mount it to any route.
+
+__You may wanna restart your server__
+
+##Contributing
+```
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+```
+
+Thank you !

data/lib/beta_invite/version.rb

@@ -1,3 +1,3 @@
 module BetaInvite
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/generators/beta_invite/views_generator.rb

@@ -0,0 +1,16 @@
+require "rails/generators"
+
+module BetaInvite
+  module Generators
+    class ViewsGenerator < Rails::Generators::Base
+      source_root File.expand_path('../../../../app/views/beta_invite/beta_invites', __FILE__)
+
+      desc "this generator would copy all the view files for beta_invite engine into your rails app"
+
+      def create_views
+        copy_file 'new.html.erb', Rails.root.join('app','views','beta_invite','beta_invites','new.html.erb')
+        copy_file 'index.html.erb', Rails.root.join('app','views','beta_invite','beta_invites','index.html.erb')
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beta_invite
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Kaushik Thirthappa
@@ -48,6 +48,7 @@ files:
 - lib/beta_invite/engine.rb
 - lib/beta_invite/version.rb
 - lib/beta_invite.rb
+- lib/generators/beta_invite/views_generator.rb
 - lib/tasks/beta_invite_tasks.rake
 - MIT-LICENSE
 - Rakefile