Skip to content

Commit fd21cc8

Browse files
committed
Package meta information style fixes
1 parent 243996f commit fd21cc8

File tree

3 files changed

+8
-20
lines changed

3 files changed

+8
-20
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,15 @@ Due to time constraints, we are not always able to respond as quickly as we woul
2222
This project comes with a configuration file for php-cs-fixer (.php_cs) that you can use to (re)format your sourcecode for compliance with this project's coding guidelines:
2323

2424
```sh
25-
vendor/bin/php-cs-fixer fix
25+
$ vendor/bin/php-cs-fixer fix
2626
```
2727

2828
## PHPUnit tests
2929

3030
The phpunit script can be used to invoke the PHPUnit test runner:
3131

3232
```sh
33-
vendor/bin/phpunit
33+
$ vendor/bin/phpunit
3434
```
3535

3636
## Reporting issues

README.md

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -89,20 +89,10 @@ Omitted entities could be retrieved by using special global scope methods, uniqu
8989

9090
## Installation
9191

92-
First, pull in the package through Composer.
92+
Pull in the package through Composer.
9393

94-
```shell
95-
composer require cybercog/laravel-eloquent-flag
96-
```
97-
98-
And then include the service provider within `app/config/app.php`.
99-
100-
*// Service provider not using yet. This step not mandatory. Will be used to boot console commands in future.*
101-
102-
```php
103-
'providers' => [
104-
Cog\Flag\Providers\FlagServiceProvider::class,
105-
];
94+
```sh
95+
$ composer require cybercog/laravel-eloquent-flag
10696
```
10797

10898
## Usage
@@ -126,7 +116,7 @@ Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
126116
Run the tests with:
127117

128118
```sh
129-
vendor/bin/phpunit
119+
$ vendor/bin/phpunit
130120
```
131121

132122
## Security

UPGRADING.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
# Upgrade Guide
22

3-
- [Upgrading From 2.0 To 3.0](#upgrade-3.0)
4-
- [Upgrading From 1.0 To 2.0](#upgrade-2.0)
3+
- [Upgrading From 2.0 To 3.0](#upgrading-from-2.0-to-3.0)
4+
- [Upgrading From 1.0 To 2.0](#upgrading-from-1.0-to-2.0)
55

6-
<a name="upgrade-3.0"></a>
76
## Upgrading From 2.0 To 3.0
87

98
You can upgrade from v2 to v3 by performing these renames in your model that has flags: `Accepted`, `Active` & `Approved`.
@@ -22,7 +21,6 @@ These methods should be renamed:
2221
- `withoutUnapproved()` has been renamed to `withoutDisapproved()`.
2322
- `onlyUnapproved()` has been renamed to `onlyDisapproved()`.
2423

25-
<a name="upgrade-2.0"></a>
2624
## Upgrading From 1.0 To 2.0
2725

2826
- Namespaces of flag's traits received `Classic` at the end: `Cog\Flag\Traits\Classic`.

0 commit comments

Comments
 (0)