jibe 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33888929add103943b15a2826aeb54e53113b58b
-  data.tar.gz: 99057dfff580047555b6776d36c4d93de035434f
+  metadata.gz: 1934e5d8e1c100412827dd32a8028beeafd68f4d
+  data.tar.gz: ca820173bb5bcf6d1e108165185fc4fd628036d7
 SHA512:
-  metadata.gz: db9c4f3ac7c1ec8f304865ebb0c604cef73f73cc99b58f2373c9c182477b129cd71288196328c504262b9fa81a75b6b127e643e348afca2f8af5afcc47dd5961
-  data.tar.gz: 33bfc22a589cf5875294df37475b38972a3e94ab94d8b68b2e5cd9adcfef218e812a4b2195cd7d1e5d09efedf5056ef4c13b86b7f34db9b70cd2083702afc879
+  metadata.gz: e6862898be25bd60e735de6aaa75d495a174972a87038ea25c8a7d243ec2de6bd15da7bc29207d9ad87482ea58820fa67323be63a4d1b9df21c090ffc877e4b1
+  data.tar.gz: 6ba56ba5725a7d1f352749d7e31be75e451672498122572d6d4a3d139109dcb29729e6cd1cc0df6b140b45ddd69eb636ba7797eb1f014888a7c8b1ea1dd3faf5

data/README.md

@@ -1,28 +1,66 @@
 # Jibe
 
-TODO: Write a gem description
+Jibe keeps simple data 'n sync with very little setup. For now, it relies on Pusher.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+First, Add `gem 'jibe'` to your application's Gemfile and `bundle`.
 
-    gem 'jibe'
+Then, [Set up Pusher.](https://github.com/pusher/pusher-gem) You'll also need to throw your pusher key into a meta tag named `pusher-key`.
 
-And then execute:
+Add `//= require jibe` to your `application.js` file.
 
-    $ bundle
+Add `jibe` to your model.
 
-Or install it yourself as:
+```
+class Comment < ActiveRecord::Base
+  jibe
+end
+```
 
-    $ gem install jibe
+Replace a collection render call:
 
-## Usage
+```
+<table>
+  <%= render @comments %>
+</table>
+```
 
-TODO: Write usage instructions here
+with:
+
+```
+<table>
+  <%= jibe @comments %>
+</table>
+```
+
+Now, all those `@comments` will stay in sync. At this point, its probably worth adding `remote: true` to your forms.
+
+## Options
+
+```
+<%=
+  jibe @comments, 
+    strategy: "prepend", # by default, new tasks are appended
+    scope: "completed", # useful in conjunction with JS callbacks
+    restrict_to: [@folder, current_user] # limit access
+%>
+```
+
+You can hijack the `beforeCreate`, `afterCreate`, `beforeUpdate`, `afterUpdate`, `beforeDestroy`, `afterDestroy` events. This is helpful for transitions.
+
+```
+Jibe.events["comments"] =
+	beforeCreate: (partial, data, scope) ->
+    # partial = the DOM node
+    # data = the model's attributes (override with jibe_data method in your model)
+    # scope = an optional scope based on the jibe tag in your view
+    
+```
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/jibe/fork )
+1. Fork it ( https://github.com/dallasread/jibe/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/jibe/version.rb

@@ -1,3 +1,3 @@
 module Jibe
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/jibe.rb

@@ -34,7 +34,6 @@ module Jibe
             Pusher["Jibe"].trigger("event", {
               action_name: action_name,
               action_capitalized: action_name.capitalize,
-              folder_id: folder_id,
               id: id,
               collection: self.class.name.downcase.pluralize,
               model: model,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jibe
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Dallas Read