## CONTENTS OF THIS FILE

 * Introduction
 * Requirements
 * Installation
 * Configuration
 * Usage
 * Maintainers


## INTRODUCTION

Friendship module.

 * For a full description of the module, visit the project page:
   https://www.drupal.org/project/friendship

 * To submit bug reports and feature suggestions, or to track changes:
   https://www.drupal.org/project/issues/friendship


## REQUIREMENTS

 * This module will require Display Suite module dependencies. Visit:
   https://www.drupal.org/project/ds


## INSTALLATION

 * Install as you would normally install a contributed Drupal module. Visit:
   https://www.drupal.org/node/1897420 for further information.


## CONFIGURATION
 * You can configure some parameters on this page at
 /admin/config/people/friendship-settings


## USAGE

You can add a friendship link to the user account display:
 * Enable Display Suite module layout on manage display for the user.
 * Now you can see the "Friendship process link".
 * You can now place the field where you want.

You can add this link using views:
 * Create a view by the user or use the user relation in a view.
 * In the user fields you can find the "Friendship process link".

The module provides 3 additional statistic fields for a user:
 * Number of friends.
 * Number of followers.
 * Number of following.

If you want to filter users by friends, followers, or following:
 * Add a relationship for friendship (appears on the user in the relation
 popup).
 * Add contextual filter by current user id (this field appears in friendship
 fields block after you add the friendship relation).
 * In the filter block there will be a new filter (Friendship status).


## MAINTAINERS

Current maintainers:
 * [Vitaliy Bogomazyuk (VitaliyB98)](https://www.drupal.org/u/vitaliyb98)

This project has been sponsored by:
 * [Internetdevels](https://www.drupal.org/internetdevels)
