Skip to content

Commit

Permalink
docs: describe and link to community-created tools and SDKs (#226)
Browse files Browse the repository at this point in the history
  • Loading branch information
mlegner authored Jan 27, 2025
1 parent fc56dda commit 70f5319
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 1 deletion.
1 change: 1 addition & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
- [Using the client CLI](./usage/client-cli.md)
- [Using the client JSON API](./usage/json-api.md)
- [Using the client HTTP API](./usage/web-api.md)
- [SDKs and other tools](./usage/sdks.md)
- [Developer guide](./dev-guide/dev-guide.md)
- [Components](./dev-guide/components.md)
- [Operations](./dev-guide/dev-operations.md)
Expand Down
7 changes: 6 additions & 1 deletion docs/usage/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,12 @@ Sites](../walrus-sites/intro.md), with code available in the
And for an example of how to build a static website and store it as a Walrus Site with GitHub
actions, just look at the [CI
workflow](https://github.com/MystenLabs/walrus-docs/blob/main/.github/workflows/publish.yaml) we use
to publish this very site.
to publish this very site. There is also a [Walrus-Sites GitHub
Action](https://github.com/zktx-io/walrus-sites-ga) created by the community you can use to very
easily publish your own Walrus Sites using GitHub Actions (note that this is *not* created or
officially supported by the Walrus team at Mysten Labs).

See also our list of existing and upcoming [SDKs and other tools](./sdks.md).

## Python

Expand Down
13 changes: 13 additions & 0 deletions docs/usage/sdks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Software development kits (SDKs) and other tools

The Walrus core team is actively working on a Rust SDK and a TypeScript SDK for Walrus. These will
cover interactions with storage nodes directly and be released around the time of the Mainnet
launch.

Besides these upcoming official SDKs, there also exist unofficial third-party SDKs for interacting
with the [HTTP API](./web-api.md#http-api-usage) exposed by Walrus aggregators and publishers:

- [Walrus Go SDK](https://github.com/namihq/walrus-go) (maintained by the *Nami Cloud* team)

Finally, there is [Tusky](https://docs.tusky.io/about/about-tusky), a complete data storage platform
built on Walrus, including encryption, HTTP APIs, sharing capabilities, and more.

0 comments on commit 70f5319

Please sign in to comment.