Skip to content
Snippets Groups Projects
Commit aaf886af authored by Łukasz Spryszak's avatar Łukasz Spryszak
Browse files

chore(readme): description fixes

parent 76b9f7e5
No related branches found
No related tags found
1 merge request!5chore(readme): description fixes
Pipeline #3047 passed with stages
in 2 minutes and 13 seconds
......@@ -4,8 +4,9 @@
[![Total Downloads](https://poser.pugx.org/wpdesk/wp-wpdesk-rating-petition/downloads)](https://packagist.org/packages/wpdesk/wp-wpdesk-rating-petition)
[![License](https://poser.pugx.org/wpdesk/wp-wpdesk-rating-petition/license)](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
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment