Contents

= MuckFriends

== Installation

The muck friends engine is part of the muck framework and relies upon the muck-engine, muck-users and muck-profiles gems.  
These gems should be installed automatically when you install the muck-friends gem.  Refer to the documentation for each
to setup configuration.  The muck-activities gem is optional.  If it is installed and enable_friend_activity is true
then friend and follow activity will be fed into the user's activity feeds

  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-activities 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
    has_activities  # requires the muck-activities gem
  end

and a user model thus:

  class User < ActiveRecord::Base
    acts_as_muck_user
    acts_as_muck_friend_user
    has_muck_profile
    has_activities # requires the muck-activities gem
  end


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

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
muck-friends-0.1.5	README.rdoc
muck-friends-0.1.2	README.rdoc
muck-friends-0.1.3	README.rdoc
muck-friends-0.1.4	README.rdoc