add doc links to readmes

streamflow-finance · May 15, 2024 · 8573132 · 8573132
1 parent 9b68da5
commit 8573132
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 0 deletions.
diff --git 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
@@ -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
@@ -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