From 2a6bdf0bd92f74f5918432d217a6552493e60070 Mon Sep 17 00:00:00 2001 From: a-komarev Date: Mon, 10 Jul 2017 12:33:30 +0300 Subject: [PATCH] Standartize project meta info --- CHANGELOG.md | 11 +++++++++-- CODE_OF_CONDUCT.md | 2 +- CONTRIBUTING.md | 4 ++-- README.md | 31 ++++++++++++++++--------------- composer.json | 2 +- 5 files changed, 29 insertions(+), 21 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 91a2e3a1..a2f7a52f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 @@ -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 @@ -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 diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 72d67f0f..3a8025aa 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -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. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9112fbb5..78bf5d66 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,7 +22,7 @@ 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 @@ -30,7 +30,7 @@ vendor/bin/php-cs-fixer fix The phpunit script can be used to invoke the PHPUnit test runner: ```sh -vendor/bin/phpunit +$ vendor/bin/phpunit ``` ## Reporting issues diff --git a/README.md b/README.md index 489da257..5337b197 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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`. @@ -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 @@ -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 @@ -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 diff --git a/composer.json b/composer.json index ab72f8c4..04c639d5 100644 --- a/composer.json +++ b/composer.json @@ -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",