diff --git a/README.md b/README.md index ab0c991..90f3ed3 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [![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) -PHP API Wrapper is a smart stack based on a couple of a Transport and a smart Wrapper for your API. +PHP API Wrapper is a smart stack based on a coupling of Transport and a smart Wrapper for your API. It is designed to be easily integrated into your projects thanks to bridges for **Laravel, Symfony, API Platform** and a **standalone stack**. ## :rocket: Installation using Composer @@ -40,25 +40,25 @@ foreach($activedUsers as $user){ } ``` -## :book: Chose your stack +## :book: Choose your stack ### :point_right: Start without Laravel or Symfony -If you decide to work without Laravel or Symfony, PHP Api Wrapper comes with a standalone Builder and a Model largely inspired by Eloquent, but really standalone. I promise ! +If you decide to work without Laravel or Symfony, PHP API Wrapper comes with a standalone Builder and a Model largely inspired by Eloquent, but really standalone. I promise! [Start without Laravel or Symfony](docs/work-standalone.md) ### :point_right: Start with Laravel -This is actualy the powerfull usage of API Wrapper. If you decide to use PHP API Wrapper with Laravel the integration approaches perfection. The builder returns Collections, all models are usable with the **Laravel Route Binding** (this is really impressive). And icing on the cake, **you can create complexes relations between Eloquent and PHP API Wrapper**. +This is the recommended usage of API Wrapper. If you decide to use PHP API Wrapper with Laravel, the integration approaches perfection. The builder returns Collections, all models are usable with the **Laravel Route Binding** (this is really impressive). And the icing on the cake, **you can create complexes relations between Eloquent and PHP API Wrapper**. [Start with Laravel](docs/work-with-laravel.md) -### :point_right: Start with Symfony (and optionally Api Platform) +### :point_right: Start with Symfony (and optionally API Platform) -This implementation is realy interesting too, the Symfony bridge provide you a Repository implementing the Doctrine RepositoryInterface which hydrates your entities. A Manager is also available which allows you to manage repositories and its connections. If you are using API Platform this is fully compatible. A API Platform Data Provider is also registered. +This implementation is really interesting too, the Symfony bridge provide you a Repository implementing the Doctrine RepositoryInterface which hydrates your entities. A Manager is also available which allows you to manage repositories and its connections. If you are using API Platform this is fully compatible. An API Platform Data Provider is also registered. -:warning: *Careful, this implementation is currently read-only. Help us to implement the missing parts !* +:warning: *Careful, this implementation is currently read-only. Help us to implement the missing parts!* [Start with Symfony](docs/work-with-symfony.md)