Skip to content

Commit

Permalink
Standartize project meta info
Browse files Browse the repository at this point in the history
  • Loading branch information
antonkomarev committed Jul 10, 2017
1 parent 8bedba1 commit 2a6bdf0
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 21 deletions.
11 changes: 9 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

All notable changes to `laravel-likeable` will be documented in this file.

## [2.2.3] - 2017-07-10

### Fixed

- Event observing of custom `Like` model (#18)

## [2.2.2] - 2017-04-09

### Fixed
Expand All @@ -28,8 +34,8 @@ All notable changes to `laravel-likeable` will be documented in this file.

## [2.0.1] - 2017-01-11

- Removed unused properties in `LikeObserver` #12
- Foreign key in migration commented out #11
- Removed unused properties in `LikeObserver` (#12)
- Foreign key in migration commented out (#11)

## [2.0.0] - 2016-09-11

Expand Down Expand Up @@ -57,6 +63,7 @@ All notable changes to `laravel-likeable` will be documented in this file.

- Initial release

[2.2.3]: https://github.com/cybercog/laravel-likeable/compare/2.2.2...2.2.3
[2.2.2]: https://github.com/cybercog/laravel-likeable/compare/2.2.1...2.2.2
[2.2.1]: https://github.com/cybercog/laravel-likeable/compare/2.2.0...2.2.1
[2.2.0]: https://github.com/cybercog/laravel-likeable/compare/2.1.0...2.2.0
Expand Down
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at oss@cybercog.su. All
reported by contacting the project team at open@cybercog.su. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,15 @@ Due to time constraints, we are not always able to respond as quickly as we woul
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:

```sh
vendor/bin/php-cs-fixer fix
$ vendor/bin/php-cs-fixer fix
```

## PHPUnit tests

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

```sh
vendor/bin/phpunit
$ vendor/bin/phpunit
```

## Reporting issues
Expand Down
31 changes: 16 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ Laravel Likeable simplify management of Eloquent model's likes & dislikes. Make
- Get Likeable models ordered by likes count.
- Events for `like`, `unlike`, `dislike`, `undislike` methods.
- Following PHP Standard Recommendations:
- [PSR-1 (Basic Coding Standard)](http://www.php-fig.org/psr/psr-1/).
- [PSR-2 (Coding Style Guide)](http://www.php-fig.org/psr/psr-2/).
- [PSR-4 (Autoloading Standard)](http://www.php-fig.org/psr/psr-4/).
- Covered with unit tests.
Expand All @@ -52,7 +53,7 @@ Laravel Likeable simplify management of Eloquent model's likes & dislikes. Make
First, pull in the package through Composer.

```sh
composer require cybercog/laravel-likeable
$ composer require cybercog/laravel-likeable
```

And then include the service provider within `app/config/app.php`.
Expand All @@ -66,8 +67,8 @@ And then include the service provider within `app/config/app.php`.
At last you need to publish and run database migrations.

```sh
php artisan vendor:publish --provider="Cog\Likeable\Providers\LikeableServiceProvider" --tag=migrations
php artisan migrate
$ php artisan vendor:publish --provider="Cog\Likeable\Providers\LikeableServiceProvider" --tag=migrations
$ php artisan migrate
```

## Usage
Expand Down Expand Up @@ -281,55 +282,55 @@ On each dislike removed `\Cog\Likeable\Events\ModelWasUndisliked` event is fired
##### Recount likes and dislikes of all model types

```sh
likeable:recount
$ likeable:recount
```

##### Recount likes and dislikes of concrete model type (using morph map alias)

```sh
likeable:recount --model="article"
$ likeable:recount --model="article"
```

##### Recount likes and dislikes of concrete model type (using fully qualified class name)

```sh
likeable:recount --model="App\Models\Article"
$ likeable:recount --model="App\Models\Article"
```

##### Recount only likes of all model types

```sh
likeable:recount --type="like"
$ likeable:recount --type="like"
```

##### Recount only likes of concrete model type (using morph map alias)

```sh
likeable:recount --model="article" --type="like"
$ likeable:recount --model="article" --type="like"
```

##### Recount only likes of concrete model type (using fully qualified class name)

```sh
likeable:recount --model="App\Models\Article" --type="like"
$ likeable:recount --model="App\Models\Article" --type="like"
```

##### Recount only dislikes of all model types

```sh
likeable:recount --type="dislike"
$ likeable:recount --type="dislike"
```

##### Recount only dislikes of concrete model type (using morph map alias)

```sh
likeable:recount --model="article" --type="dislike"
$ likeable:recount --model="article" --type="dislike"
```

##### Recount only dislikes of concrete model type (using fully qualified class name)

```shell
likeable:recount --model="App\Models\Article" --type="dislike"
```sh
$ likeable:recount --model="App\Models\Article" --type="dislike"
```

## Extending
Expand Down Expand Up @@ -382,12 +383,12 @@ Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
You can run the tests with:

```sh
vendor/bin/phpunit
$ vendor/bin/phpunit
```

## Security

If you discover any security related issues, please email oss@cybercog.su instead of using the issue tracker.
If you discover any security related issues, please email open@cybercog.su instead of using the issue tracker.

## Credits

Expand Down
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
],
"homepage": "https://github.com/cybercog/laravel-likeable",
"support": {
"email": "oss@cybercog.su",
"email": "open@cybercog.su",
"issues": "https://github.com/cybercog/laravel-likeable/issues",
"wiki": "https://github.com/cybercog/laravel-likeable/wiki",
"source": "https://github.com/cybercog/laravel-likeable",
Expand Down

0 comments on commit 2a6bdf0

Please sign in to comment.