Skip to content

Commit eae6362

Browse files
committed
refactor: update readme
1 parent a153652 commit eae6362

File tree

1 file changed

+16
-10
lines changed

1 file changed

+16
-10
lines changed

php/README.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,22 @@
1-
## Installation
1+
# About Algolia's API Client PHP
22

3-
> **Requires [PHP 7.2+](https://php.net/releases/)**
3+
Algolia's API Client php was created by, and is maintained by [Algolia](https://github.com/algolia). The Algolia Search API Client for php lets you easily use the Algolia Search REST API from your php code.
44

5-
```bash
6-
git clone https://github.com/algolia/api-clients-playground
7-
```
5+
## Get started locally
6+
7+
> **Requires:**
8+
- **[PHP 7.2+](https://php.net/releases/)**
9+
- **[Composer](https://getcomposer.org/)**
810

11+
First, use *composer* to playground dependencies:
912
```bash
10-
cd api-clients-playground/php && composer install
13+
# Go inside the playground ruby folder
14+
cd api-clients-playground/php
15+
# Install dependencies
16+
composer install
1117
```
1218

13-
## Usage
14-
15-
1. Edit the file `bin/index.php`.
16-
2. Run the php file using: `php bin/index.php`.
19+
Finally, edit and run the code on `bin/index.php`:
20+
```
21+
php bin/index.php
22+
```

0 commit comments

Comments
 (0)