Update readme

Author: ankurk91

readme.md

@@ -1,60 +1,47 @@
-<p align="center"><img src="https://laravel.com/assets/img/components/logo-laravel.svg"></p>
-
-<p align="center">
-<a href="https://travis-ci.org/laravel/framework"><img src="https://travis-ci.org/laravel/framework.svg" alt="Build Status"></a>
-<a href="https://packagist.org/packages/laravel/framework"><img src="https://poser.pugx.org/laravel/framework/d/total.svg" alt="Total Downloads"></a>
-<a href="https://packagist.org/packages/laravel/framework"><img src="https://poser.pugx.org/laravel/framework/v/stable.svg" alt="Latest Stable Version"></a>
-<a href="https://packagist.org/packages/laravel/framework"><img src="https://poser.pugx.org/laravel/framework/license.svg" alt="License"></a>
-</p>
-
-## About Laravel
-
-Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel attempts to take the pain out of development by easing common tasks used in the majority of web projects, such as:
-
-- [Simple, fast routing engine](https://laravel.com/docs/routing).
-- [Powerful dependency injection container](https://laravel.com/docs/container).
-- Multiple back-ends for [session](https://laravel.com/docs/session) and [cache](https://laravel.com/docs/cache) storage.
-- Expressive, intuitive [database ORM](https://laravel.com/docs/eloquent).
-- Database agnostic [schema migrations](https://laravel.com/docs/migrations).
-- [Robust background job processing](https://laravel.com/docs/queues).
-- [Real-time event broadcasting](https://laravel.com/docs/broadcasting).
-
-Laravel is accessible, yet powerful, providing tools needed for large, robust applications.
-
-## Learning Laravel
-
-Laravel has the most extensive and thorough [documentation](https://laravel.com/docs) and video tutorial library of any modern web application framework, making it a breeze to get started learning the framework.
-
-If you're not in the mood to read, [Laracasts](https://laracasts.com) contains over 1100 video tutorials on a range of topics including Laravel, modern PHP, unit testing, JavaScript, and more. Boost the skill level of yourself and your entire team by digging into our comprehensive video library.
-
-## Laravel Sponsors
-
-We would like to extend our thanks to the following sponsors for helping fund on-going Laravel development. If you are interested in becoming a sponsor, please visit the Laravel [Patreon page](https://patreon.com/taylorotwell):
-
-- **[Vehikl](https://vehikl.com/)**
-- **[Tighten Co.](https://tighten.co)**
-- **[Kirschbaum Development Group](https://kirschbaumdevelopment.com)**
-- **[Cubet Techno Labs](https://cubettech.com)**
-- **[British Software Development](https://www.britishsoftware.co)**
-- [Fragrantica](https://www.fragrantica.com)
-- [SOFTonSOFA](https://softonsofa.com/)
-- [User10](https://user10.com)
-- [Soumettre.fr](https://soumettre.fr/)
-- [CodeBrisk](https://codebrisk.com)
-- [1Forge](https://1forge.com)
-- [TECPRESSO](https://tecpresso.co.jp/)
-- [Runtime Converter](http://runtimeconverter.com/)
-- [WebL'Agence](https://weblagence.com/)
-- [Invoice Ninja](https://www.invoiceninja.com)
-
-## Contributing
-
-Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions).
-
-## Security Vulnerabilities
-
-If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.
-
-## License
-
-The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
+# Laravel Socialite with Multiple Providers
+
+> An example project that covers login with multiple social providers.
+
+## Setup
+Follow Laravel installation [steps](https://laravel.com/docs/5.6/installation#installation)
+
+### What has been covered?
+* Login/Sign-up with Google and Github, you can add as many as you can.
+* Fire `RegisteredEvent` on new user creation same as default `RegistratonController`.
+* Create and associate social account when email address already exists.
+* Create user if email address does not exists in `users` table.
+
+### What has not been covered?
+* Storing access token.
+* Storing user avatar.
+* Providers that does not return `email` address for example Facebook.
+* Allow users to change their email address.
+* Allow users to disconnect from their social account.
+* Allow logged-in users to connect to their social account.
+* Allow users to change their account password without knowing the current, because they have logged-in via socialite.
+
+### How to add new provider?
+* Add provider name in routes `where()` method, for example - `twitter`
+```php
+->where('provider', 'google|github|twitter');
+```
+* Make room for new credentials in `config/services.php`
+```php
+'twitter' => [
+        'client_id' => env('TWITTER_OAUTH_CLIENT_ID'),
+        'client_secret' => env('TWITTER_OAUTH_CLIENT_SECRET'),
+        'redirect' => env('TWITTER_OAUTH_REDIRECT'),
+    ],
+```
+* Update `.env.example` and `.env`
+```.dotenv
+# Twitter OAuth
+# https://developer.twitter.com
+TWITTER_OAUTH_CLIENT_ID=
+TWITTER_OAUTH_CLIENT_SECRET=
+TWITTER_OAUTH_REDIRECT=${APP_URL}/oauth/github/callback
+```
+* That's it. You are done.
+
+### License
+Same as Laravel, [MIT license](https://opensource.org/licenses/MIT)