Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add doc links to readmes #172

Merged
merged 1 commit into from
May 16, 2024
Merged

add doc links to readmes #172

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
3 changes: 3 additions & 0 deletions packages/distributor/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 2 additions & 0 deletions packages/stream/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading