Skip to content

Improve README #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improve README #46

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)