Add LICENSE, improve README and fix typo

Author: Camille Baronnet

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 CristalTeam
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,12 +1,25 @@
 # PHP API Wrapper
 
+[![Latest Stable Version](https://img.shields.io/packagist/v/cristal/php-api-wrapper.svg?style=flat-square)](https://packagist.org/packages/cristal/php-api-wrapper)
+[![GitHub issues](https://img.shields.io/github/issues/cristalTeam/php-api-wrapper.svg?style=flat-square)](https://github.com/cristalTeam/php-api-wrapper/issues)
+[![GitHub license](https://img.shields.io/github/license/cristalTeam/php-api-wrapper.svg?style=flat-square)](https://github.com/cristalTeam/php-api-wrapper/blob/master/LICENSE)
+
+
+## Installation using Composer
+
+```bash
+composer require cristal/php-api-wrapper
+```
+
+## Usage
+
 PHP API Wrapper is a Laravel Eloquent like, built to work with APIs. The integration of each API consists of three steps:
 
 - The Transport
 - The Wrapper
 - The Models and Builder
 
-## 1. The Transport
+### 1. The Transport
 
 The Transport is an implementation of `TransportInterface`, it manages the API Autentication, 
 returns desialized data, and manage HTTP errors with `ApiException` and childs (see `src/Exceptions`).
@@ -31,7 +44,7 @@ $users = $transport->request('/users');
 
 ```
 
-## 2. The Wrapper
+### 2. The Wrapper
 
 A wrapper is a standalone class that must follow a specific implementation.
 For example, consider a User (create, read, delete and update), implementation. Here's what your wrapper should look like :
@@ -96,7 +109,7 @@ class CustomWraper extends Api
 }
 ```
 
-# 3. Chose your stack
+## 3. Chose your stack
 
 - [Work without Laravel or Symfony](docs/work-standalone.md)
 - [Work with Laravel](docs/work-with-laravel.md)

composer.json

@@ -12,7 +12,10 @@
   },
   "suggest": {
     "barryvdh/laravel-debugbar": "To support request tracking in your Laravel app.",
-    "laravel/framework":  "To integrate Laravel Collection, Pagination and Eloquent relations with your models."
+    "laravel/framework":  "To integrate Laravel Collection, Pagination and Eloquent relations with your models.",
+    "symfony/symfony" : "To integrate a ManagerRegistry, a Paginator and support serialization with your entities.",
+    "api-platform/core" : "To integrate a DataProvider and support the Paginator of the Api Platform in addition to the support of Symfony.",
+    "league/oauth2-client" : "To support OAuth2 request Transport."
   },
   "autoload": {
     "psr-4": {

docs/work-standalone.md

@@ -46,9 +46,9 @@ Congratulation, you are quite ready to use your implementation like Eloquent :
 ```php
 <?php
 
-$activedUser = User::where(['active' => true])->get();
+$activedUsers = User::where(['active' => true])->get();
 
-foreach($activedUser as $user){
+foreach($activedUsers as $user){
     $user->active = false;
     $user->save();
 }

docs/work-with-laravel.md

@@ -21,7 +21,7 @@ class AppServiceProvider extends ServiceProvider
 {
     public function boot(): void
     {
-        Model::setApi($this->app->mak(Api::class));
+        Model::setApi($this->app->make(Api::class));
     }
 
     public function register()
@@ -69,9 +69,9 @@ Congratulation, you are quite ready to use your implementation like Eloquent :
 ```php
 <?php
 
-$activedUser = User::where(['active' => true])->get();
+$activedUsers = User::where(['active' => true])->get();
 
-foreach($activedUser as $user){
+foreach($activedUsers as $user){
     $user->active = false;
     $user->save();
 }