From 3b5c24f3e57f3822c09970a86e2289a6d6cea580 Mon Sep 17 00:00:00 2001 From: DraperStudio Date: Mon, 2 Mar 2015 11:06:51 +0100 Subject: [PATCH] Update README.md to new template --- src/stubs/README.stub | 70 ++----------------------------------------- 1 file changed, 2 insertions(+), 68 deletions(-) diff --git a/src/stubs/README.stub b/src/stubs/README.stub index b8d8fb6..a8b7647 100644 --- a/src/stubs/README.stub +++ b/src/stubs/README.stub @@ -6,72 +6,6 @@ [![Latest Unstable Version](https://img.shields.io/packagist/vpre/{{nameLowerCase}}/goodreads.svg?style=flat-square)](https://packagist.org/packages/{{nameLowerCase}}/goodreads) [![License](https://img.shields.io/packagist/l/{{nameLowerCase}}/goodreads.svg?style=flat-square)](https://packagist.org/packages/{{nameLowerCase}}/goodreads) - - -## Contents +## Documentation -- [Installation](#installation) - - [1. Composer](#1-composer) - - [2. Service Provider](#2-service-provider) - - [3. Add the Event and Listeners](#3-add-the-event-and-listeners) - - [4. Services Array and .env](#4-services-array-and-env) - - [Add to `config/services.php`.](#add-to-configservicesphp) - - [Append provider values to your `.env` file](#append-provider-values-to-your-env-file) -- [Usage](#usage) - - - - -## Installation - -### 1. Composer - -```bash -// This assumes that you have composer installed globally -composer require socialiteproviders/{{nameLowerCase}} -``` - -### 2. Service Provider - -* [See the docs on how to install the `SocialiteProviders` service provider.](https://github.com/SocialiteProviders/Manager#2-service-provider) - - -### 3. Add the Event and Listeners - -* The listener that you will be adding is `'SocialiteProviders\{{nameStudlyCase}}\{{nameStudlyCase}}ExtendSocialite@handle',`. - -* [See the docs on how to install](https://github.com/SocialiteProviders/Manager#3-add-the-event-and-listeners) - -### 4. Services Array and .env - -#### Add to `config/services.php`. - -```php -'{{nameLowerCase}}' => [ - 'client_id' => env('{{nameUppercase}}_KEY'), - 'client_secret' => env('{{nameUppercase}}_SECRET'), - 'redirect' => env('{{nameUppercase}}_REDIRECT_URI'), -], -``` - -#### Append provider values to your `.env` file - -```php -// other values above -{{nameUppercase}}_KEY=yourkeyfortheservice -{{nameUppercase}}_SECRET=yoursecretfortheservice -{{nameUppercase}}_REDIRECT_URI=https://example.com/login -``` - -* [See the main docs for more information](https://github.com/SocialiteProviders/Manager#4-services-array-and-env) - - -## Usage - -* You should now be able to use it like you would regularly use Socialite: - -```php -return Socialite::with('{{nameLowerCase}}')->redirect(); -``` - -* [See the main docs for more information](https://github.com/SocialiteProviders/Manager#usage) +Full documentation for using this provider can be found at [{{nameStudlyCase}} Documentation](http://socialiteproviders.github.io/providers/{{nameLowerCase}}/)