From 7533ffa48f49022abbdf5ff605508517b4b63b78 Mon Sep 17 00:00:00 2001
From: Don Alfons Nisnoni <donnisnoni@outlook.com>
Date: Tue, 5 Jan 2021 00:37:10 +0800
Subject: [PATCH] mysql: add README.md (#7824)

---
 vlib/mysql/README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 vlib/mysql/README.md

diff --git a/vlib/mysql/README.md b/vlib/mysql/README.md
new file mode 100644
index 0000000000..3a0f601a3f
--- /dev/null
+++ b/vlib/mysql/README.md
@@ -0,0 +1,30 @@
+For Linux, you need to install `MySQL development` package and `pkg-config`.
+For Windows, install [the installer](https://dev.mysql.com/downloads/installer/) ,
+then copy the `include` and `lib` folders to `<V install directory>\thirdparty\mysql`.
+
+## Basic Usage
+
+```v
+import mysql
+
+// Create connection
+mut connection := mysql.Connection{
+	username: 'root'
+	dbname: 'mysql'
+}
+// Connect to server
+connection.connect() ?
+// Change the default database
+connection.select_db('db_users') ?
+// Do a query
+get_users_query_result := connection.query('SELECT * FROM users') ?
+// Get the result as maps
+for user in get_users_query_result.maps() {
+	// Access the name of user
+	println(user['name'])
+}
+// Free the query result
+get_users_query_result.free()
+// Close the connection if needed
+connection.close()
+```