basic README

Author: NikolayS

README.md

@@ -0,0 +1,38 @@
+Description
+===
+Nancy helps to conduct automated database experiments.
+
+The Nancy Command Line Interface is a unified way to manage database
+experiments.
+
+Experiments are needed every time you:
+ - add or remove indexes;
+ - want to verify query optimization ideas;
+ - need to tune database parameters;
+ - want to perform performance/stress test for your DB;
+ - are preparing to upgrade your DBMS to the new major version;
+ - want to train ML model related to DB optimization.
+
+Currently Nancy works only with PostgreSQL versions 9.6 and 10.
+
+Requirements
+===
+Linux or MacOS machine with installed Docker. To use Nancy CLI on AWS EC2
+instances, you also need Docker Machine (https://docs.docker.com/machine/).
+
+Installation
+===
+```bash
+git clone https://github.com/startupturbo/nancy
+echo "export PATH=\$PATH:"$(pwd)"/nancy" >> ~/.bashrc
+source ~/.bashrc
+```
+
+Getting started
+===
+To these commands:
+```bash
+nancy help
+nancy run help
+```
+