Skip to content

Commit f589870

Browse files
committed
docs: update README.md
1 parent 4f78675 commit f589870

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.md

+13-7
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# asyncmy - A fast asyncio MySQL driver
1+
# asyncmy - A fast asyncio MySQL/MariaDB driver
22

33
[![image](https://img.shields.io/pypi/v/asyncmy.svg?style=flat)](https://pypi.python.org/pypi/asyncmy)
44
[![image](https://img.shields.io/github/license/long2ice/asyncmy)](https://github.com/long2ice/asyncmy)
@@ -7,15 +7,16 @@
77

88
## Introduction
99

10-
`asyncmy` is a fast asyncio MySQL driver, which reuse most of [pymysql](https://github.com/PyMySQL/PyMySQL)
10+
`asyncmy` is a fast asyncio MySQL/MariaDB driver, which reuse most of [pymysql](https://github.com/PyMySQL/PyMySQL)
1111
and [aiomysql](https://github.com/aio-libs/aiomysql) but rewrite core protocol with [cython](https://cython.org/) to
1212
speedup.
1313

1414
## Features
1515

1616
- API compatible with [aiomysql](https://github.com/aio-libs/aiomysql).
17-
- Faster with [cython](https://cython.org/).
18-
- MySQL replication protocol support.
17+
- Faster by [cython](https://cython.org/).
18+
- MySQL replication protocol support with `asyncio`.
19+
- Tested both MySQL and MariaDB in [CI](https://github.com/long2ice/asyncmy/blob/dev/.github/workflows/ci.yml).
1920

2021
## Benchmark
2122

@@ -37,26 +38,31 @@ The result comes from [benchmark](./benchmark).
3738
```shell
3839
pip install asyncmy
3940
```
41+
4042
### Installing on Windows
43+
4144
To install asyncmy on Windows, you need to install the tools needed to build it.
4245

4346
1. Download *Microsoft C++ Build Tools* from https://visualstudio.microsoft.com/visual-cpp-build-tools/
4447
2. Run CMD as Admin (not required but recommended) and navigate to the folder when your installer is downloaded
45-
3. Installer executable should look like this `vs_buildtools__XXXXXXXXX.XXXXXXXXXX.exe`, it will be easier if you rename it to just `vs_buildtools.exe`
48+
3. Installer executable should look like this `vs_buildtools__XXXXXXXXX.XXXXXXXXXX.exe`, it will be easier if you rename
49+
it to just `vs_buildtools.exe`
4650
4. Run this command (Make sure you have about 5-6GB of free storage)
51+
4752
```shell
4853
vs_buildtools.exe --norestart --passive --downloadThenInstall --includeRecommended --add Microsoft.VisualStudio.Workload.NativeDesktop --add Microsoft.VisualStudio.Workload.VCTools --add Microsoft.VisualStudio.Workload.MSBuildTools
4954
```
55+
5056
5. Wait until the installation is finished
5157
6. After installation will finish, restart your computer
52-
7. Install asyncmy via PIP
58+
7. Install asyncmy via PIP
59+
5360
```shell
5461
pip install asyncmy
5562
```
5663

5764
Now you can uninstall previously installed tools.
5865

59-
6066
## Usage
6167

6268
### Use `connect`

0 commit comments

Comments
 (0)