Skip to content
This repository was archived by the owner on Feb 9, 2026. It is now read-only.

Commit 3b8abab

Browse files
Readme update (#11)
* Update readme * fix link to each provider readme * fix code identation on trustpilot and reviewsIo request examples
1 parent 458b8d5 commit 3b8abab

File tree

3 files changed

+28
-15
lines changed

3 files changed

+28
-15
lines changed

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,18 @@ A review is an evaluation of a publication, product, or company for example. In
2929
composer require pod-point/reviews-php
3030
```
3131

32+
##### Publish the configuration - Laravel
33+
1. Add the provider to the list of providers on config/app.php
34+
```php
35+
PodPoint\Reviews\LaravelServiceProvider::class
36+
37+
```
38+
39+
2.
40+
```php
41+
php artisan vendor:publish
42+
```
43+
3244
## Usage
3345
The Reviews class takes an array as the first parameter, see example of config file below:
3446
```php
@@ -73,8 +85,9 @@ $trustpilot->merchant()->findReview((string) $reviewId);
7385
$trustpilot->merchant()->getReviews((array) $serviceReviewsFilterOptions);
7486
```
7587

76-
For more details about each provider options see:
77-
* [Trustpilot](https://github.com/Pod-Point/reviews-php/Providers/Trustpilot/README.md)
88+
For more details about each provider request options see:
89+
* [Trustpilot](https://github.com/Pod-Point/reviews-php/blob/master/src/Providers/Trustpilot/README.md)
90+
* [ReviewsIO](https://github.com/Pod-Point/reviews-php/blob/master/src/Providers/ReviewsIo/README.md)
7891

7992
## Semantic versioning
8093
Reviews PHP follows [semantic versioning](https://semver.org/) specifications.

src/Providers/ReviewsIo/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,12 @@ Required Fields:
3535

3636
```php
3737
$reviewsIo->merchant()->invite([
38-
'store': 'my-company',
39-
'apikey': '######APIKEY######',
40-
'name': 'Mr David Jones',
41-
'email': 'david-jones@example.com',
42-
'order_id': '12345',
43-
'template_id': '934',
38+
'store' => 'my-company',
39+
'apikey' => '######APIKEY######',
40+
'name' => 'Mr David Jones',
41+
'email' => 'david-jones@example.com',
42+
'order_id' => '12345',
43+
'template_id' => '934',
4444
]);
4545

4646
```
@@ -51,8 +51,8 @@ See all the supported parameters
5151

5252
```php
5353
$reviewsIo->merchant()->getReviews([
54-
'min_date' => '2013-09-07',
55-
'max_date' => '2013-09-20',
54+
'min_date' => '2013-09-07',
55+
'max_date' => '2013-09-20',
5656
]);
5757
```
5858
See all supported query parameters and responses:

src/Providers/Trustpilot/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,13 @@ Required Fields:
4040

4141
```php
4242
$trustpilot->merchant()->invite([
43-
'consumerEmail' => 'john.doe@trustpilot.com',
44-
'consumerName'=> 'John Doe',
43+
'consumerEmail' => 'john.doe@trustpilot.com',
44+
'consumerName' => 'John Doe',
4545
'replyTo' => 'john.doe@trustpilot.com',
4646
'referenceNumber' => 'inv00001',
4747
'locale' => 'en-US',
4848
'senderEmail' => 'john.doe@trustpilot.com',
49-
'serviceReviewInvitation' => [
49+
'serviceReviewInvitation' => [
5050
'preferredSendTime' => '2013-09-07T13:37:00',
5151
'redirectUri' => "http://trustpilot.com',
5252
'tags'=> [
@@ -63,8 +63,8 @@ $trustpilot->merchant()->invite([
6363

6464
```php
6565
$trustpilot->merchant()->getReviews([
66-
'startDateTime' => '2013-09-07T13:37:00',
67-
'endDateTime' => '2013-09-20T13:37:00',
66+
'startDateTime' => '2013-09-07T13:37:00',
67+
'endDateTime' => '2013-09-20T13:37:00',
6868
]);
6969
```
7070
See all supported query parameters and responses:

0 commit comments

Comments
 (0)