From 85731320df4df9bf507f111632f9642270b4627e Mon Sep 17 00:00:00 2001 From: "roman.rolgin" Date: Wed, 15 May 2024 19:16:06 +0300 Subject: [PATCH] add doc links to readmes --- README.md | 3 +++ packages/distributor/README.md | 3 +++ packages/stream/README.md | 2 ++ 3 files changed, 8 insertions(+) diff --git a/README.md b/README.md index 0e340c91..1b0dc6bc 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,9 @@ There are several ways to use **Streamflow**: Protocol audits available [here](https://www.notion.so/streamflow/Streamflow-Security-Audits-3250070c0b3a4a0690385d96316d645c). Partner oracle audit available here [here](https://github.com/streamflow-finance/rust-sdk/blob/main/partner_oracle_audit.pdf). +## Documentation +API Documentation available here: [docs site →](https://streamflow-finance.github.io/js-sdk/) + ## JS SDK to interact with Streamflow protocols This repo consists of js-sdk to interact with several protocol exposed by streamflow: diff --git a/packages/distributor/README.md b/packages/distributor/README.md index 72d0b7f7..c5370d8c 100644 --- a/packages/distributor/README.md +++ b/packages/distributor/README.md @@ -16,6 +16,9 @@ or `yarn add @streamflow/common @streamflow/distributor` +## Documentation +API Documentation available here: [docs site →](https://streamflow-finance.github.io/js-sdk/) + ## Import SDK Most common imports: diff --git a/packages/stream/README.md b/packages/stream/README.md index 431c77f8..01766106 100644 --- a/packages/stream/README.md +++ b/packages/stream/README.md @@ -14,6 +14,8 @@ or `yarn add @streamflow/stream` +## Documentation +API Documentation available here: [docs site →](https://streamflow-finance.github.io/js-sdk/) ## Import SDK