Skip to content

Commit 746b6f6

Browse files
authored
Add MariaDB to readme.md
MariaDB is mentioned in CI, so MariaDB could be mentioned in readme too
1 parent dc9c152 commit 746b6f6

1 file changed

Lines changed: 8 additions & 2 deletions

File tree

Readme.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,9 @@ $ npm install mysqljs/mysql
9696
This is a node.js driver for mysql. It is written in JavaScript, does not
9797
require compiling, and is 100% MIT licensed.
9898

99+
The driver implements the MySQL wire protocol and is tested against MySQL and
100+
MariaDB in CI (see `.github/workflows/ci.yml`).
101+
99102
Here is an example on how to use it:
100103

101104
```js
@@ -1543,7 +1546,7 @@ For a good pull request, we ask you provide the following:
15431546

15441547
The test suite is split into two parts: unit tests and integration tests.
15451548
The unit tests run on any machine while the integration tests require a
1546-
MySQL server instance to be setup.
1549+
MySQL-protocol-compatible database server (MySQL or MariaDB) to be setup.
15471550

15481551
### Running unit tests
15491552

@@ -1558,7 +1561,10 @@ Set the environment variables `MYSQL_DATABASE`, `MYSQL_HOST`, `MYSQL_PORT`,
15581561
of `MYSQL_HOST` and `MYSQL_PORT` to connect over a UNIX socket. Then run
15591562
`npm test`.
15601563

1561-
For example, if you have an installation of mysql running on localhost:3306
1564+
The project's CI workflow runs integration tests against multiple MySQL and
1565+
MariaDB versions; see `.github/workflows/ci.yml` for the full matrix.
1566+
1567+
For example, if you have an installation of MySQL or MariaDB running on localhost:3306
15621568
and no password set for the `root` user, run:
15631569

15641570
```sh

0 commit comments

Comments
 (0)