From f2724f37ad2f21b90f4f58ced7110009fac37f60 Mon Sep 17 00:00:00 2001
From: Daniel Bulant <admin@danbulant.eu>
Date: Tue, 14 Apr 2020 12:36:49 +0200
Subject: [PATCH] Add readme about setting up and running mysql exporter

---
 README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ca43d16
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# MySQL exporter
+
+MySQL exporter is a simple tool for generating data dictionaries from database.
+
+## Configuring
+
+The exporter uses simple config.json, **in the current workind directory**. Just create config.json and use the following format:
+
+```json
+{
+    "mysql": {
+        "host": "localhost",
+        "user": "root",
+        "password": "",
+        "database": "mysql"
+    },
+    "fields_ignored": []
+}
+```
+
+Fields ignored is an array of fields which shouldn't be in the report. It's case insensitive.
+
+## Running
+
+If you have [node](http://nodejs.org) and [git](https://git-scm.com/) installed on your system, simply create the config and run `npx github:danbulant/mysqlExporter`.
+
+## Saving and sharing reports
+
+On the newly opened page (opened by running), press `ctrl+s` and save the HTML file. That file is fully self-contained, even for offline use, so you can share the report with others.