From aaf886afe5650ab306b24fa5a9d11758e08f073c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C5=81ukasz=20Spryszak?= <4544831-lusp@users.noreply.gitlab.com> Date: Fri, 24 Jun 2022 06:42:42 +0000 Subject: [PATCH] chore(readme): description fixes --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c62a131..7c60d35 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,9 @@ [](https://packagist.org/packages/wpdesk/wp-wpdesk-rating-petition) [](https://packagist.org/packages/wpdesk/wp-wpdesk-rating-petition) -WordPress Library to ask for good rate in repository. -==================================================== +# Rating Petition + +A WordPress library which can be used to encourage the plugin users to review and rate it in WordPress repository. ## Requirements @@ -13,7 +14,7 @@ PHP 7.0 or later. ## Installation via Composer -In order to install the bindings via Composer run the following command: +In order to install the bindings via [Composer](http://getcomposer.org/) run the following command: ```bash composer require wpdesk/wp-wpdesk-rating-petition @@ -21,7 +22,8 @@ composer require wpdesk/wp-wpdesk-rating-petition ## Example usage -### When using in shipping zones: +### To use it in the shipping zones area: + ```php function init_repository_rating() { $time_tracker = new \WPDesk\RepositoryRating\TimeWatcher\ShippingMethodInstanceWatcher( @@ -40,7 +42,7 @@ function init_repository_rating() { } ``` -### When using in shipping method: +### To use it on the shipping method screen: ```php <?php -- GitLab