From a14be2afa6a55e329094a21f5b8e692f2c97798d Mon Sep 17 00:00:00 2001 From: Zander Hill Date: Sat, 11 Apr 2020 15:07:04 -0700 Subject: [PATCH] Update README to move Quickstart forward --- README.md | 22 ++++++++++++++-------- docs/README.template.md | 22 ++++++++++++++-------- 2 files changed, 28 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 23125e4..e492dc2 100644 --- a/README.md +++ b/README.md @@ -10,10 +10,22 @@ MoreSQL streams changes occuring in Mongo database into a Postgres db. MoreSQL t MoreSQL gives you a chance to use more sql and less mongo query language. +## QuickStart +### Introduction + +* Create metadata table +* Setup moresql.json (see Configuration) +* Setup any recipient tables in postgres + * Validate with `./moresql -validate` +* Deploy moresql binary to server from Github Releases +* Configure Environmental variables +* Run `./moresql -tail` to start transmitting novelty +* Run `./moresql -full-sync` to populate the database +* Write more sql ;D + # Usage ## Basic Use - ### Configuration moresql.json configuration structure @@ -243,13 +255,7 @@ As of writing, any BsonID/ObjectId should be noted as `id` type in `Fields.Mongo ## Converting from MoSQL -Run the ./bin/convert_config_from_mosql_to_moresql script in a folder with `collections.yml` - -``` -ruby ./bin/convert_config_from_mosql_to_moresql collection.yml -``` - -The generated file `moresql.json` will be in place ready for use. +Read through configuration structure and convert your collections.yml into the new json format. ## Unsupported Features diff --git a/docs/README.template.md b/docs/README.template.md index 046f975..e6cbeb2 100644 --- a/docs/README.template.md +++ b/docs/README.template.md @@ -10,10 +10,22 @@ MoreSQL streams changes occuring in Mongo database into a Postgres db. MoreSQL t MoreSQL gives you a chance to use more sql and less mongo query language. +## QuickStart +### Introduction + +* Create metadata table +* Setup moresql.json (see Configuration) +* Setup any recipient tables in postgres + * Validate with `./moresql -validate` +* Deploy moresql binary to server from Github Releases +* Configure Environmental variables +* Run `./moresql -tail` to start transmitting novelty +* Run `./moresql -full-sync` to populate the database +* Write more sql ;D + # Usage ## Basic Use - ### Configuration moresql.json configuration structure @@ -185,13 +197,7 @@ As of writing, any BsonID/ObjectId should be noted as `id` type in `Fields.Mongo ## Converting from MoSQL -Run the ./bin/convert_config_from_mosql_to_moresql script in a folder with `collections.yml` - -``` -ruby ./bin/convert_config_from_mosql_to_moresql collection.yml -``` - -The generated file `moresql.json` will be in place ready for use. +Read through configuration structure and convert your collections.yml into the new json format. ## Unsupported Features