Skip to content
This repository has been archived by the owner on Apr 10, 2024. It is now read-only.

Commit

Permalink
Update README to remove later quickstart
Browse files Browse the repository at this point in the history
  • Loading branch information
zph committed Apr 11, 2020
1 parent a14be2a commit 9db7217
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 32 deletions.
19 changes: 3 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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`

Expand Down
19 changes: 3 additions & 16 deletions docs/README.template.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down

0 comments on commit 9db7217

Please sign in to comment.