diff --git a/README.md b/README.md index e492dc2..d70810b 100644 --- a/README.md +++ b/README.md @@ -118,20 +118,7 @@ https://zph.github.io/moresql/ [![GoDoc](https://godoc.org/github.com/zph/moresql?status.svg)](https://godoc.org/github.com/zph/moresql) -## QuickStart - -### Introduction - -* Create metadata table -* Setup moresql.json -* Setup any recipient tables in postgres - * Validate with `./moresql -validate` -* Deploy binary to server -* Configure Environmental variables -* Run `./moresql -tail` to start transmitting novelty -* Run `./moresql -full-sync` to populate the database - -### Table Setup +## Table Setup ```sql -- Execute the following SQL to setup table in Postgres. Replace $USERNAME with the moresql user. @@ -154,11 +141,11 @@ COMMENT ON COLUMN public.moresql_metadata.processed_at IS 'Timestamp for when th COMMENT ON TABLE public.moresql_metadata IS 'Stores checkpoint data for MoreSQL (mongo->pg) streaming'; ``` -### Building Binary +## Building Binary Compile binary using `make build` -### Commandline Arguments / Usage +## Commandline Arguments / Usage Execute `./moresql --help` diff --git a/docs/README.template.md b/docs/README.template.md index e6cbeb2..8702861 100644 --- a/docs/README.template.md +++ b/docs/README.template.md @@ -118,30 +118,17 @@ https://zph.github.io/moresql/ [![GoDoc](https://godoc.org/github.com/zph/moresql?status.svg)](https://godoc.org/github.com/zph/moresql) -## QuickStart - -### Introduction - -* Create metadata table -* Setup moresql.json -* Setup any recipient tables in postgres - * Validate with `./moresql -validate` -* Deploy binary to server -* Configure Environmental variables -* Run `./moresql -tail` to start transmitting novelty -* Run `./moresql -full-sync` to populate the database - -### Table Setup +## Table Setup ```sql $SQL_OUTPUT ``` -### Building Binary +## Building Binary Compile binary using `make build` -### Commandline Arguments / Usage +## Commandline Arguments / Usage Execute `./moresql --help`