feedback_router 0.8.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: addfeefe9ad0079780cc980e3904cd1163d1ff33
-  data.tar.gz: 00f8754a708e000e41bf202c8d508d906ed3389d
+  metadata.gz: 5d69385ddb1a643378969c25e8c2879c3594f002
+  data.tar.gz: 6383eeb5c980bbf1340a5856304183e177437066
 SHA512:
-  metadata.gz: 4fb81489b2fb68bcb84fb6e11098dad5912e9e27c597f59a9df0bcb1e720c1a251e8a86fafc03c703f90a7d6cf084a30e3fa6f1534bbafea2c7c2a2f739bd5f0
-  data.tar.gz: 3c8d39edfc3243d129e782b001cd0ec538c8bee4497b551c73cbc21f78a056baf996b6f39c18870e192e713f08a5d39095b7ff063cc181d4cb36442375af93cc
+  metadata.gz: 2c71874a9c80c56b8f9b2a4be1ca76843bc03964b9c88f9c7c58f23fbad3e808119e838485ed0a3ec94a8ffa17e018adabb39f2462f5e01f4b2e0e06beca1db4
+  data.tar.gz: 5114e29d17d15d3ba0f3eacb921dfd73363fe10195338051ff1ec4cac0fd54a439bf3f93e698a643f6479ea2a57b22769951a3885a0b4e50ad85947f53043c5d

data/README.md

@@ -16,13 +16,25 @@ Or install it yourself as:
 
     $ gem install feedback_router
 
-## Usage
+Once the Gem is installed you have to create an environment of the location that the feedback will be sent to. The environment variable must be called ```ENV['FEEDBACK_LOCATION']``` and should reflect the entire URL of where the data is being sent (for example ```http://localhost:3000/example_route```).
 
-TODO: Write usage instructions here
+#Usage
+
+After installing the gem, paste the following bit of code into your application_controller.rb:
+
+    protect_from_forgery with: :null_session, if: Proc.new { |c| c.request.format == 'application/json' }
+    
+This will allow the feedback_router gem to send data through to your create method.
+
+Now all you have to do is call the gem after the feedback params have been given, like so:
+
+    FeedbackRouter.send(feedback_params, "Name of Application")
+    
+Where "Name of Application" is the name of the Rails App sending the feedback.
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/feedback_router/fork )
+1. Fork it ( https://github.com/ElliottAYoung/feedback_router/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/feedback_router.rb

@@ -17,6 +17,7 @@ module FeedbackRouter
 
   def self.set_params(feedback_params, application_name)
     feedback_params['app_name'] = application_name
+    feedback_params
   end
 
   def self.send_request

data/lib/feedback_router/version.rb

@@ -1,3 +1,3 @@
 module FeedbackRouter
-  VERSION = "0.8.2"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: feedback_router
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Elliott Young