Skip to content

Commit

Permalink
Merge pull request #1 from joshuapinter/patch-1
Browse files Browse the repository at this point in the history
Fix formatting of README.markdown.
  • Loading branch information
grosser committed Mar 17, 2018
2 parents 52e361e + 3770166 commit b2c4c47
Showing 1 changed file with 15 additions and 11 deletions.
26 changes: 15 additions & 11 deletions README.markdown
@@ -1,17 +1,18 @@
- Simple activity logging build on top of [userstamp](http://github.com/delynn/userstamp)
# Record Activities

- Simple activity logging build on top of [userstamp](http://github.com/delynn/userstamp)
- Does not involve the controller
- Stores an Activity(:action, :actor, :subject) in the database
- Supports :create, :update, :save and :destroy by default + any user-defined action

Setup
=====
## Setup

- Install and setup [userstamps](http://github.com/delynn/userstamp)
- ` script/plugin install git://github.com/grosser/record_activities.git `
- Create an activities table for your database (see: [MIGRATION](http://github.com/grosser/record_activities/blob/master/MIGRATION))
- (Optional) Add `has_many :activities, :dependent => :destroy, :foreign_key => :actor_id` to your user

Usage
=====
## Usage

class Comment < ActiveRecord::Base
stampable
Expand All @@ -29,12 +30,15 @@ A Comment `has_many :activities`, if the :association or :dependent option is gi

Activity recording can be turned off by setting e.g. `Comment.record_userstamp` to false.

AUTHORS
=======
###Contributors
## AUTHORS

### Contributors

- [rxcfc](http://in.finitu.de/)

###Author
### Author

[Michael Grosser](http://pragmatig.wordpress.com)
grosser.michael@gmail.com
Hereby placed under public domain, do what you want, just do not hold me accountable...
grosser.michael@gmail.com

Hereby placed under public domain, do what you want, just do not hold me accountable...

0 comments on commit b2c4c47

Please sign in to comment.