event_hooks 0.0.1 → 0.0.2

data/README.md

@@ -1,6 +1,7 @@
 # EventHooks
 
-TODO: Write a gem description
+EventHooks enhances Ruby classes to allow adding pre-conditions to method calls (events).
+If the pre-conditions method returns false the event method will not run. It can be used on ActiveRecord subclasses to validate some conditions only when a certain event occurs. 
 
 ## Installation
 
@@ -18,7 +19,28 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Within the class that you want to hook the pre-condition to simply write:
+```ruby
+  hook_before :event, :hook
+```
+
+where:
+* event is the name of a method that you must define prior to the hook_before.
+* hook is the name of a method that will be run before the call to event. 
+
+```ruby
+class AnyClass
+	def submit
+	  # do something
+	end
+	hook_before :submit, :submit_preconditions
+
+  def submit_preconditions
+	  am_i_ready?
+  end
+end
+```
+
 
 ## Contributing
 

data/lib/event_hooks/version.rb

@@ -1,3 +1,3 @@
 module EventHooks
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: event_hooks
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors: