Skip to content

Commit 95e6114

Browse files
author
Lupacescu Eduard
authored
Update README.md
1 parent 3f060db commit 95e6114

File tree

1 file changed

+27
-2
lines changed

1 file changed

+27
-2
lines changed

README.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
1-
# Laravel REST API helpers I reuse for every project
1+
# Laravel magic REST API builder
22

33
[![Latest Version on Packagist](https://img.shields.io/packagist/v/binaryk/laravel-restify.svg?style=flat-square)](https://packagist.org/packages/binaryk/laravel-restify)
44
[![Build Status](https://img.shields.io/travis/binaryk/laravel-restify/master.svg?style=flat-square)](https://travis-ci.org/binaryk/laravel-restify)
55
[![Quality Score](https://img.shields.io/scrutinizer/g/binaryk/laravel-restify.svg?style=flat-square)](https://scrutinizer-ci.com/g/binaryk/laravel-restify)
66
[![Test Coverage](https://img.shields.io/scrutinizer/coverage/g/binaryk/laravel-restify.svg?style=flat-square)](https://scrutinizer-ci.com/g/binaryk/laravel-restify)
77
[![Total Downloads](https://img.shields.io/packagist/dt/binaryk/laravel-restify.svg?style=flat-square)](https://packagist.org/packages/binaryk/laravel-restify)
88

9-
No description
9+
This package will generate the API resources "CRUD" for you. By using Laravel buit in Policies and Eloquent Resource API the implementation become a pleasure.
10+
11+
The response is made according with [JSON:API](https://jsonapi.org/format/) standard.
1012

1113
## Installation
1214

@@ -16,6 +18,29 @@ You can install the package via composer:
1618
composer require binaryk/laravel-restify
1719
```
1820

21+
## Key havings
22+
23+
- "CRUD" over resources with 0 (zero) extra custom code
24+
- Passport authentication (use `php artisan restify:check-passport` for it's setup)
25+
- Auth module (register, verify, login, reset + forgot password)
26+
- Beautiful response maker
27+
- Powerful and configurable searching/filtering over entities
28+
- API friendly Exception Handler
29+
30+
## Quick start
31+
32+
Setup package:
33+
34+
```bash
35+
php artisan restify:setup
36+
```
37+
38+
Generate repository:
39+
40+
```bash
41+
php artisan restify:repository Post
42+
```
43+
1944
## Usage
2045

2146
See the [official documentation](https://binaryk.github.io/laravel-restify/).

0 commit comments

Comments
 (0)