Skip to content

Commit 45d2f06

Browse files
committed
update README.md
1 parent 777a415 commit 45d2f06

File tree

1 file changed

+20
-30
lines changed

1 file changed

+20
-30
lines changed

README.md

Lines changed: 20 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,11 @@
11
# This is my package laravel-presenter
22

33
[![Latest Version on Packagist](https://img.shields.io/packagist/v/coderflex/laravel-presenter.svg?style=flat-square)](https://packagist.org/packages/coderflex/laravel-presenter)
4-
[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/coderflex/laravel-presenter/run-tests?label=tests)](https://github.com/coderflex/laravel-presenter/actions?query=workflow%3Arun-tests+branch%3Amain)
5-
[![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/coderflex/laravel-presenter/Check%20&%20fix%20styling?label=code%20style)](https://github.com/coderflex/laravel-presenter/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
6-
[![Total Downloads](https://img.shields.io/packagist/dt/coderflex/laravel-presenter.svg?style=flat-square)](https://packagist.org/packages/coderflex/laravel-presenter)
4+
[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/coderflex/laravel-presenter/run-tests?label=tests)](https://github.com/coderflexx/laravel-presenter/actions?query=workflow%3Arun-tests+branch%3Amain)
5+
[![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/coderflex/laravel-presenter/Check%20&%20fix%20styling?label=code%20style)](https://github.com/coderflexx/laravel-presenter/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
76

87
This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
98

10-
## Support us
11-
12-
[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/laravel-presenter.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/laravel-presenter)
13-
14-
We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
15-
16-
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
17-
189
## Installation
1910

2011
You can install the package via composer:
@@ -23,38 +14,37 @@ You can install the package via composer:
2314
composer require coderflex/laravel-presenter
2415
```
2516

26-
You can publish and run the migrations with:
27-
28-
```bash
29-
php artisan vendor:publish --tag="laravel-presenter-migrations"
30-
php artisan migrate
31-
```
32-
3317
You can publish the config file with:
3418

3519
```bash
36-
php artisan vendor:publish --tag="laravel-presenter-config"
20+
vendor:publish --provider="Coderflex\LaravelPresenter\LaravelPresenterServiceProvider"
3721
```
3822

3923
This is the contents of the published config file:
4024

4125
```php
4226
return [
43-
];
44-
```
4527

46-
Optionally, you can publish the views using
47-
48-
```bash
49-
php artisan vendor:publish --tag="laravel-presenter-views"
28+
/*
29+
|--------------------------------------------------------------------------
30+
| Presenter Namespace
31+
|--------------------------------------------------------------------------
32+
|
33+
| This value informs LaravelPresenter which namespace you will be
34+
| selecting to store your presenters by default.
35+
| If this value equals to null, "App\Presenter" will be used
36+
| by default.
37+
|
38+
*/
39+
40+
'presenter_namespace' => 'App\\Presenters',
41+
];
5042
```
5143

5244
## Usage
5345

54-
```php
55-
$laravelPresenter = new Coderflex\LaravelPresenter();
56-
echo $laravelPresenter->echoPhrase('Hello, Coderflex!');
57-
```
46+
<!-- TODO: document the package usage -->
47+
5848

5949
## Testing
6050

@@ -76,7 +66,7 @@ Please review [our security policy](../../security/policy) on how to report secu
7666

7767
## Credits
7868

79-
- [Coderflex](https://github.com/coderflexx)
69+
- [Coderflex](https://github.com/coderflexxx)
8070
- [All Contributors](../../contributors)
8171

8272
## License

0 commit comments

Comments
 (0)