README

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

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


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

Social Auth Pinterest Module is a Pinterest 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/pinterest.
 * A settings form at /admin/config/social-api/social-auth/pinterest.
 * A Pinterest 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 the dependencies.
   composer require ragasirtahk/social_auth_pinterest

 * 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 Pinterest project OAuth information in
   Configuration » User Authentication » Pinterest.

 * Place a Social Auth Pinterest 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 Pinterest logo on the Social Auth Login block.
You can also add a button or link anywhere on the site that points to
/user/login/pinterest, so theming and customizing the button or link
is very flexible.

When the user opens the /user/login/pinterest link, it automatically takes
user to Pinterest Accounts for authentication. Pinterest then returns the user
to Drupal site. If we have an existing Drupal user with the same email address
provided by Pinterest, that user is logged in. Otherwise a new Drupal user is
created.


SUPPORT REQUESTS
----------------

Before posting a support request, carefully read the installation
instructions provided in module documentation page.

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/social_auth_pinterest/issues

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:
 * Sagar Khatri (ragasirtahk) - https://www.drupal.org/u/ragasirtahk
ragasirtahk / social_auth_pinterest

Maintainers

Details

README
