Contents

= MuckFriends

== Installation

The muck friends engine is part of the muck framework and relies upon the muck_engine as well as the muck-users gem.  Both gems should be installed automatically when you install the muck-friends gem.  Refer
to the documentation for muck-users for muck-users configuration.

  sudo gem install muck-friends

Add this to environment.rb:

    config.gem 'muck-friends', :lib => 'muck_friends'


Inside of global_config.yml add the following, changing the emails to match your application:

  default: &DEFAULT

    # Sent in emails to users
    application_name: 'Name of my application'
    from_email: '[e-mail]'
    support_email: '[e-mail]'
    admin_email: '[e-mail]'

    # Friend configuration
    allow_following:  true        # If true then users can 'follow' each other.  If false then only friend requests will be used.
    enable_friend_activity: true  # If true then friend related activity will show up in the activity feed.  Requires muck-activity gem
    
== Usage

You will need a friend model that 'acts_as_muck_friend' and a user model that 'acts_as_muck_friend_user'

== Example
After installing the gem just create a friend model thus:

  class Friend < ActiveRecord::Base  
    acts_as_muck_friend
    # install muck-activities and uncomment the following to have friend notifications show up in each user's activity feed.
    # has_activities
    # after_create :add_activity
  end

and a user model thus:

  class User < ActiveRecord::Base
    acts_as_muck_user
    acts_as_muck_friend_user
  end


Copyright (c) 2009 Justin Ball, released under the MIT license

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
muck-friends-0.1.1	README.rdoc