Update README.md

README.md

@@ -4,17 +4,24 @@
   <img src="./images/preview.png" width="150px" alt="Project social preview"> 
 </p>
 
+---------------------------
+
 [![Create release](https://github.com/usedatabrew/blink/actions/workflows/release.yaml/badge.svg)](https://github.com/usedatabrew/blink/actions/workflows/release.yaml)
 ![Latest version (latest semver)](https://img.shields.io/docker/v/usedatabrew/blink)
 
-Blink ETL gives you the ability to create truly flexible data pipelines to implement even-driven architecture, database replication and data lakes
+Blink ETL gives you the ability to create truly flexible data pipelines to implement even-driven architecture, database replication, and data lakes
+
+# Table of Contents
+1. [Installation](#getting-started)
+2. [Running Blink locally](#running-blink-locally)
+3. [Docs](https://docs.databrew.tech/get-started-with-open-source.html)
 
 ## Getting started
-Let's give blink a try. Check out different options to start Blink on your local machine
+Let's give Blink a try. Check out different options to start Blink on your local machine
 
 ### Run with Docker on Linux
-Currently, we offer only linux-based arm64 build for docker
-Create config with the name `blink.yaml` and run docker image
+Currently, we offer only Linux-based arm64 build for docker
+Create a config with the name `blink.yaml` and run the docker image
 
 ```shell
 docker run -v blink.yaml:/blink.yaml usedatabrew/blink start
@@ -23,11 +30,52 @@ docker run -v blink.yaml:/blink.yaml usedatabrew/blink start
 ### Install Golang binary
 
 ```shell
-go get -u github.com/usedatabrew/blink
+go install -u github.com/usedatabrew/blink
 ```
 
+### Install with Homebrew (MacOS)
+
 ```shell
-blink start -c blink-config.yaml
+brew tap usedatabrew/blink
+brew install usedatabrew/blink
 ```
 
-### Install with Homebrew (MacOS)
+### Running Blink locally
+
+To run Blink locally - you have to create a config file that will define streams
+
+```yaml
+service:
+  id: 123
+  pipeline_id: 1234
+  stream_schema:
+    - stream: crypto_price_change
+      columns:
+        - name: name
+          databrewType: String
+          pk: true
+          nullable: false
+        - name: price
+          databrewType: Float64
+          pk: false
+          nullable: false
+
+source:
+  driver: websocket
+  config:
+    url: ws://databrew-ws-gateway.fly.dev/ws
+
+processors:
+  - driver: sql
+    config:
+      query: "select * from streams.crypto_price_change where name = 'BTC'"
+
+sink:
+  driver: stdout
+  config: {}
+```
+
+
+```shell
+blink start -c blink-config.yaml
+```