From 746b6f69c20e51e99915a6573cf1fff83b778bd9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Sil=C3=A9n?= Date: Fri, 15 May 2026 11:35:31 +0300 Subject: [PATCH] Add MariaDB to readme.md MariaDB is mentioned in CI, so MariaDB could be mentioned in readme too --- Readme.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/Readme.md b/Readme.md index c83c14766..858de3aea 100644 --- a/Readme.md +++ b/Readme.md @@ -96,6 +96,9 @@ $ npm install mysqljs/mysql This is a node.js driver for mysql. It is written in JavaScript, does not require compiling, and is 100% MIT licensed. +The driver implements the MySQL wire protocol and is tested against MySQL and +MariaDB in CI (see `.github/workflows/ci.yml`). + Here is an example on how to use it: ```js @@ -1543,7 +1546,7 @@ For a good pull request, we ask you provide the following: The test suite is split into two parts: unit tests and integration tests. The unit tests run on any machine while the integration tests require a -MySQL server instance to be setup. +MySQL-protocol-compatible database server (MySQL or MariaDB) to be setup. ### Running unit tests @@ -1558,7 +1561,10 @@ Set the environment variables `MYSQL_DATABASE`, `MYSQL_HOST`, `MYSQL_PORT`, of `MYSQL_HOST` and `MYSQL_PORT` to connect over a UNIX socket. Then run `npm test`. -For example, if you have an installation of mysql running on localhost:3306 +The project's CI workflow runs integration tests against multiple MySQL and +MariaDB versions; see `.github/workflows/ci.yml` for the full matrix. + +For example, if you have an installation of MySQL or MariaDB running on localhost:3306 and no password set for the `root` user, run: ```sh