add usage paragraph

cargo-one · Nov 11, 2022 · 2e83dec · 2e83dec
1 parent 7b87091
commit 2e83dec
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -11,3 +11,13 @@ This tap:
   - [Answers](https://docs.zenloop.com/reference/get-answers)
 - Outputs the schema for each resource
 - Incrementally pulls data based on the input state
+
+## Usage
+
+* Create a copy of the `sample_config.json`
+* Fill in your API key and add the surveys you want to sync
+* Run `tap-zenloop -c config.json --discover > catalog.json`
+* Set `"selected": true` on the schema of the `answers` stream
+* Run the first sync: `tap-zenloop -c config.json --catalog catalog.json`
+* Process the STATE messages of the output stream to create a state file.
+* In subsequent runs include the state to only load new answers: `tap-zenloop -c config.json --catalog catalog.json --state state.json`