CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Installation
 * Configuration
 * How it works
 * Support requests
 * Maintainers


INTRODUCTION
------------

Social Auth Vkontakte is a Vkontakte Authentication integration for Drupal. It
is based on the Social Auth and Social API projects.

It adds to the site:
 * A new url: /user/login/vkontakte.
 * A settings form at /admin/config/social-api/social-auth/vkontakte.
 * A Vkontakte logo in the Social Auth Login block.


REQUIREMENTS
------------

This module requires the following modules:

 * Social Auth (https://drupal.org/project/social_auth)
 * Social API (https://drupal.org/project/social_api)


INSTALLATION
------------

 * Run composer to install dependencies:
   composer require "drupal/social_auth_vkontakte:^2.0"

 * Install the dependencies: Social API and Social Auth.

 * Install as you would normally install a contributed Drupal module. See:
   https://drupal.org/documentation/install/modules-themes/modules-8
   for further information.


CONFIGURATION
-------------

 * Add your Vkontakte project OAuth information in
   Configuration » User Authentication » Vkontakte.

 * Place a Social Auth Login block in Structure » Block Layout.

 * If you already have a Social Auth Login block in the site, rebuild the cache.


HOW IT WORKS
------------

User can click on the Vkontakte logo on the Social Auth Login block
You can also add a button or link anywhere on the site that points
to /user/login/vkontakte, so theming and customizing the button or link
is very flexible.

When the user opens the /user/login/vkontakte link, it automatically takes the
user to Vkontakte Accounts for authentication. Vkontakte then returns the user
to Drupal site. If we have an existing Drupal user with the same email address
provided by Vkontakte or the user has previously registered using Vkontakte,
user is logged in. If not, a new user account is created. Also, a Vkontakte
account can be associated to an authenticated user.


SUPPORT REQUESTS
----------------
Before posting a support request, check Recent log entries at
admin/reports/dblog

Once you have done this, you can post a support request at module issue queue:
https://www.drupal.org/project/issues/social_auth_vk

When posting a support request, please inform what does the status report say
at admin/reports/dblog and if you were able to see any errors in
Recent log entries.


MAINTAINERS
-----------

Current maintainers:
 * Getulio Sánchez (gvso) - https://www.drupal.org/u/gvso
 * Himanshu Dixit (himanshu-dixit) - https://www.drupal.org/u/himanshu-dixit
 * CimpleO