README.md in activity_engine-0.0.7 vs README.md in activity_engine-0.0.8
- old
+ new
@@ -1,7 +1,9 @@
# ActivityEngine
+[![Build Status](https://travis-ci.org/ndlib/activity_engine.png)](https://travis-ci.org/ndlib/activity_engine)
+
A mountable Rails engine for both recording activity and displaying activity on
a persisted object.
## Installation
@@ -21,19 +23,15 @@
To record activity, register a class and method via a Rails generator.
$ rails g activity_engine:register <ClassName> <MethodName> <Subject>
-Or by hand in a config/initializers/activity_engine_config.rb
+Or by hand in a config/post_initializers/activity_engine_config.rb
ActivityEngine.register('<ClassName>', '<MethodName>') do |activity,context|
activity.subject = context.<subject>
activity.user = context.current_user
activity.activity_type = "an arbitrary type"
activity.message = "A particulare message?"
end
Then, whenever the ClassName#MethodName is invoke an activity will be recorded.
-
-## TODO
-
-* Provide a means for retrieving an object's activities
\ No newline at end of file