add: README.md

depocket · Nov 28, 2022 · d29f0fe · d29f0fe
1 parent 3898103
commit d29f0fe
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 32 deletions.
diff --git a/.local/main.go b/.local/main.go
diff --git a/README.md b/README.md
@@ -0,0 +1,21 @@
+# Near lake framework on Golang
+## How to install
+```
+go get github.com/depocket/near-lake-framework-go
+```
+
+## How to use
+```golang
+config := core.DefaultLakeConfigBuilder().
+		      Mainnet().
+	          SetStartBlockHeight(79075963).
+	          SetBlocksPreloadPoolSize(100).
+	          Build()
+channel := core.Streamer(*config)
+for {
+    select {
+    case message := <-channel:
+        fmt.Println(message.Shards[0].Chunk.Receipts)
+    }
+}
+```