Skip to content

Commit b377357

Browse files
committed
Update Readme.md and composer.json
1 parent e9f3b64 commit b377357

File tree

2 files changed

+39
-11
lines changed

2 files changed

+39
-11
lines changed

README.md

+37-10
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
1-
# Very short description of the package
1+
# Repository Pattern implementation for Laravel
22

33
[![Latest Version on Packagist](https://img.shields.io/packagist/v/mawuekom/laravel-repository.svg?style=flat-square)](https://packagist.org/packages/mawuekom/laravel-repository)
44
[![Total Downloads](https://img.shields.io/packagist/dt/mawuekom/laravel-repository.svg?style=flat-square)](https://packagist.org/packages/mawuekom/laravel-repository)
55

6-
This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what PSRs you support to avoid any confusion with users and contributors.
6+
This is a Simple Repository Pattern implementation for Laravel Projects and
7+
an easily way to build Eloquent queries from API requests.
78

89
## Installation
910

@@ -13,10 +14,40 @@ You can install the package via composer:
1314
composer require mawuekom/laravel-repository
1415
```
1516

17+
## configuration
18+
19+
### Laravel <br/>
20+
21+
After register the service provider to the **`providers`** array in **`config/app.php`**
22+
23+
```php
24+
'providers' =>
25+
...
26+
Mawuekom\Repository\RepositoryServiceProvider::class
27+
...
28+
];
29+
```
30+
<br/>
31+
32+
Publish package config
33+
34+
```bash
35+
php artisan vendor:publish --provider="Mawuekom\Repository\RepositoryServiceProvider"
36+
```
37+
38+
### Lumen <br/>
39+
40+
Go to **`bootstrap/app.php`**, and add this in the specified key
41+
42+
```php
43+
$app->register(Mawuekom\Repository\RepositoryServiceProvider::class);
44+
45+
```
46+
1647
## Usage
1748

1849
```php
19-
// Usage description here
50+
// Coming soon
2051
```
2152

2253
### Testing
@@ -33,14 +64,10 @@ Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recen
3364

3465
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
3566

36-
### Security
37-
38-
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
39-
40-
## Credits
67+
### **Hope this package will help you build awesome things** <br><br>
4168

42-
- [Ephraïm Seddor](https://github.com/mawuva)
43-
- [All Contributors](../../contributors)
69+
## Report bug
70+
Contact me on Twitter [@ephraimseddor](https://twitter.com/ephraimseddor)
4471

4572
## License
4673

composer.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@
1818
"require": {
1919
"php": "^7.3|^7.4|^8.0",
2020
"illuminate/support": "^8.0",
21-
"illuminate/database": "^8.0"
21+
"illuminate/database": "^8.0",
22+
"mawuekom/laravel-searchable": "^1.1"
2223
},
2324
"require-dev": {
2425
"orchestra/testbench": "^6.0",

0 commit comments

Comments
 (0)