From ba9efc2be0e610a4aba9733d2850965d169460c0 Mon Sep 17 00:00:00 2001
From: Elizabeth Engelman <emengelman@gmail.com>
Date: Mon, 9 Apr 2018 11:51:21 -0500
Subject: [PATCH] Updates to README

- update configuration section
- remove creating and migrating the db as a prerequisite for running test - it doesn't seem to be necessary
- add a public.toml.example config file to be copied and updated locally
---
 README.md                        | 58 ++++++++++++++++----------------
 environments/public.toml.example |  7 ++++
 2 files changed, 36 insertions(+), 29 deletions(-)
 create mode 100644 environments/public.toml.example

diff --git a/README.md b/README.md
index db43cc98..884ce714 100644
--- a/README.md
+++ b/README.md
@@ -2,55 +2,55 @@
 
 [![Build Status](https://travis-ci.org/vulcanize/VulcanizeDB.svg?branch=master)](https://travis-ci.org/vulcanize/VulcanizeDB)
 
-### Dependencies
-
+## Dependencies
  - Go 1.9+
- - Postgres 10 
+ - Postgres 10
  - Ethereum Node
    - [Go Ethereum](https://ethereum.github.io/go-ethereum/downloads/) (1.8+)
    - [Parity 1.8.11+](https://github.com/paritytech/parity/releases)
-   
-### Installation 
+
+## Installation
 `go get github.com/vulcanize/vulcanizedb`
 
-### Setting up the Databases
-
+## Setting up the Database
 1. Install Postgres
 1. Create a superuser for yourself and make sure `psql --list` works without prompting for a password.
-1. `createdb vulcanize_private`
+1. `createdb vulcanize_public`
 1. `cd $GOPATH/src/github.com/vulcanize/vulcanizedb`
-1. Import the schema: `psql vulcanize_private < db/schema.sql`
+1. Import the schema: `psql vulcanize_public < db/schema.sql`
 
    or run the migrations: `make migrate HOST_NAME=localhost NAME=vulcanize_public PORT=5432`
     * See below for configuring additional environments
-    
-### IPC File Paths
 
-The default location for Ethereum is:
- - `$HOME/Library/Ethereum` for Mac
- - `$HOME/.ethereum` for Ubuntu
- - `$GOPATH/src/gihub.com/vulcanize/vulcanizedb/test_data_dir/geth.ipc` for private node.
+## Configuration
+- To use a local Ethereum node, copy `environments/public.toml.example` to
+  `environments/public.toml` and update the `ipcPath` to the local node's IPC filepath:
+  - when using geth:
+    - The IPC file is called `geth.ipc`.
+    - The geth IPC file path is printed to the console when you start geth.
+    - The default location is:
+      - Mac: `$HOME/Library/Ethereum`
+      - Linux: `$HOME/.ethereum`
 
-**Note the location of the ipc file is printed to the console when you start geth. It is needed to for configuration**
+  - when using parity:
+    - The IPC file is called `jsonrpc.ipc`.
+    - The default location is:
+      - Mac: `$HOME/Library/Application\ Support/io.parity.ethereum/`
+      - Linux: `$HOME/.local/share/io.parity.ethereum/`
+
+- `environments/infura.toml` can be used to run commands with a full
+  archive node, rather than a local quick sync node.
 
 ## Start syncing with postgres
-1. Start geth node (**if fast syncing wait for geth to finsh initial sync**)
+Syncs VulcanizeDB with the configured Ethereum node.
+1. Start node (**if fast syncing wait for initial sync to finish**)
 1. In a separate terminal start vulcanize_db
     - `vulcanizedb sync --config <config.toml> --starting-block-number <block-number>`
-    
-   * see `./environments` for example config 
 
 ## Running the Tests
 
 ### Unit Tests
+- `go test ./pkg/...`
 
-1. `go test ./pkg/...`
-
-### Integration Test
-
-1. Setup a test database and import the schema: 
-
-   `createdb vulcanize_private`
-   
-    `psql vulcanize_private < db/schema.sql`
-1. `go test ./...` to run all tests.
+### Integration Tests
+ - `go test ./...` to run all tests.
diff --git a/environments/public.toml.example b/environments/public.toml.example
new file mode 100644
index 00000000..05ace18e
--- /dev/null
+++ b/environments/public.toml.example
@@ -0,0 +1,7 @@
+[database]
+name = "vulcanize_public"
+hostname = "localhost"
+port = 5432
+
+[client]
+ipcPath = <local node's IPC filepath>