Clientbase
/
json-api-server
mirror of https://github.com/basemaster/json-api-server.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README formatting

This commit is contained in:
Toby Zerner 2019-11-19 11:59:31 +10:30
parent b23014ec8a
commit 91c0387b5b
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -3,13 +3,17 @@
[![Pre Release](https://img.shields.io/packagist/vpre/tobyz/json-api-server.svg?style=flat)](https://github.com/tobyz/json-api-server/releases) [![Pre Release](https://img.shields.io/packagist/vpre/tobyz/json-api-server.svg?style=flat)](https://github.com/tobyz/json-api-server/releases)
[![License](https://img.shields.io/packagist/l/tobyz/json-api-server.svg?style=flat)](https://packagist.org/packages/tobyz/json-api-server) [![License](https://img.shields.io/packagist/l/tobyz/json-api-server.svg?style=flat)](https://packagist.org/packages/tobyz/json-api-server)
**A fully automated [JSON:API](http://jsonapi.org) server implementation in PHP.** > **A fully automated [JSON:API](http://jsonapi.org) server implementation in PHP.**
Define your schema, plug in your models, and we'll take care of the rest. 🍻 > Define your schema, plug in your models, and we'll take care of the rest. 🍻
## Installation
```bash ```bash
composer require tobyz/json-api-server composer require tobyz/json-api-server
``` ```
## Usage
```php ```php
use Tobyz\JsonApiServer\Adapter\EloquentAdapter; use Tobyz\JsonApiServer\Adapter\EloquentAdapter;
use Tobyz\JsonApiServer\JsonApi; use Tobyz\JsonApiServer\JsonApi;
@ -505,10 +509,14 @@ You should indicate to the server if the consumer is authenticated using the `au
$api->authenticated(); $api->authenticated();
``` ```
## Examples
* TODO
## Contributing ## Contributing
Feel free to send pull requests or create issues if you come across problems or have great ideas. Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
## License ## License
This code is published under the [The MIT License](LICENSE). This means you can do almost anything with it, as long as the copyright notice and the accompanying license file is left intact. [MIT](LICENSE)