|
1 | | -reactphp-mysql |
2 | | -=============== |
| 1 | +# MySQL |
3 | 2 |
|
4 | | -## Install |
5 | | - |
6 | | -The recommended way to install reactphp-mysql is through [composer](http://getcomposer.org). |
7 | | - |
8 | | -``` |
9 | | -{ |
10 | | - "require": { |
11 | | - "react/mysql": "0.2.*" |
12 | | - } |
13 | | -} |
14 | | -``` |
15 | | - |
16 | | -## Introduction |
17 | | - |
18 | | -This is a mysql driver for [reactphp](https://github.com/reactphp/react), It is written |
19 | | -in pure PHP, implemented the mysql protocol. |
| 3 | +Async, [Promise](https://github.com/reactphp/promise)-based MySQL database client |
| 4 | +for [ReactPHP](https://reactphp.org/). |
20 | 5 |
|
21 | | -See examples for usage details. |
| 6 | +This is a MySQL database driver for [ReactPHP](https://reactphp.org/). |
| 7 | +It implements the MySQL protocol and allows you to access your existing MySQL |
| 8 | +database. |
| 9 | +It is written in pure PHP and does not require any extensions. |
22 | 10 |
|
23 | 11 | ## Usage |
24 | 12 |
|
@@ -61,10 +49,31 @@ $connector = new \React\Socket\Connector($loop, array( |
61 | 49 | $connection = new Connection($loop, $options, $connector); |
62 | 50 | ``` |
63 | 51 |
|
64 | | -## Thanks |
| 52 | +## Install |
| 53 | + |
| 54 | +The recommended way to install this library is [through Composer](https://getcomposer.org). |
| 55 | +[New to Composer?](https://getcomposer.org/doc/00-intro.md) |
| 56 | + |
| 57 | +This will install the latest supported version: |
| 58 | + |
| 59 | +```bash |
| 60 | +$ composer require react/mysql:^0.2 |
| 61 | +``` |
| 62 | + |
| 63 | +## License |
| 64 | + |
| 65 | +MIT, see [LICENSE file](LICENSE). |
65 | 66 |
|
66 | | -Thanks to the following projects. |
| 67 | +This is a community project now managed by |
| 68 | +[@friends-of-reactphp](https://github.com/friends-of-reactphp). |
| 69 | +The original implementation was created by |
| 70 | +[@bixuehujin](https://github.com/bixuehujin) starting in 2013 and has been |
| 71 | +migrated to [@friends-of-reactphp](https://github.com/friends-of-reactphp) in |
| 72 | +2018 to help with maintenance and upcoming feature development. |
67 | 73 |
|
68 | | -* [phpdaemon](https://github.com/kakserpom/phpdaemon): the mysql protocol implemention based some code of the project. |
69 | | -* [node-mysql](https://github.com/felixge/node-mysql): take some inspirations from this project for API design. |
| 74 | +The original implementation was made possible thanks to the following projects: |
70 | 75 |
|
| 76 | +* [phpdaemon](https://github.com/kakserpom/phpdaemon): the MySQL protocol |
| 77 | + implementation is based on code of this project (with permission). |
| 78 | +* [node-mysql](https://github.com/felixge/node-mysql): the API design is |
| 79 | + inspired by this project. |
0 commit comments