Merge pull request #53 from startupturbo/NikolayS-patch-1

"Hello world" example, more details on installation

Author: startupturbo

README.md

@@ -53,18 +53,32 @@ Currently Supported Features
 
 Requirements
 ===
-To use Nancy CLI you need Linux or MacOS with installed Docker. If you plan
-to run experiments in AWS EC2 instances, you also need Docker Machine
-(https://docs.docker.com/machine/).
+1) To use Nancy CLI you need Linux or MacOS with installed Docker.
+
+2) To run on AWS EC2 instances, you also need:
+  * AWS CLI https://aws.amazon.com/en/cli/
+  * Docker Machine https://docs.docker.com/machine/
+  * jq https://stedolan.github.io/jq/
+
 
 Installation
 ===
+
+In the minimal configuration, only two steps are needed:
+
+1) Install Docker (for Ubuntu/Debian: `sudo apt-get install docker`)
+2) Clone this repo and adjust `$PATH`:
 ```bash
 git clone https://github.com/startupturbo/nancy
 echo "export PATH=\$PATH:"$(pwd)"/nancy" >> ~/.bashrc
 source ~/.bashrc
 ```
 
+Additionally, to allow use of AWS EC2 instances:
+3) Follow instructions https://docs.aws.amazon.com/cli/latest/userguide/installing.html
+4) Follow instructions https://docs.docker.com/machine/install-machine/
+5) install jq (for Ubuntu/Debian: `sudo apt-get install jq`)
+
 Getting started
 ===
 Start with these commands:
@@ -73,3 +87,25 @@ nancy help
 nancy run help
 ```
 
+"Hello World!"
+===
+```bash
+echo "create table hello_world as select i::int4 from generate_series(1, 1000000) _(i);" > ./sample.dump
+bzip2 ./sample.dump
+
+# "Clean run": w/o index
+# (seqscan is expected, total time ~150ms, depending on resources)
+nancy run \
+  --run-on localhost \
+  --workload-custom-sql "select count(1) from hello_world where i between 100000 and 100010;" \
+  --db-dump-path file://$(pwd)/sample.dump.bz2 --tmp-path /tmp
+
+# Now check how a regular btree index affects performance
+# (expected total time: ~0.05ms)
+nancy run \
+  --run-on localhost \
+  --workload-custom-sql "select count(1) from hello_world where i between 100000 and 100010;" \
+  --db-dump-path file://$(pwd)/sample.dump.bz2 --tmp-path /tmp \
+  --target-ddl-do "create index i_hello_world_i on hello_world(i);" \
+  --target-ddl-undo "drop index i_hello_world_i;"
+```