From a4a754d48c1a86677d50efc1ff6bb653a61c46b7 Mon Sep 17 00:00:00 2001
From: Scott McKeon <smckeon@spideroak.com>
Date: Mon, 3 Feb 2025 13:22:25 -0800
Subject: [PATCH] Add rust example app to rust api page

---
 pages/_technical-apis/rust-api.md | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/pages/_technical-apis/rust-api.md b/pages/_technical-apis/rust-api.md
index d4b572b..b82afe1 100644
--- a/pages/_technical-apis/rust-api.md
+++ b/pages/_technical-apis/rust-api.md
@@ -29,9 +29,15 @@ The daemon's responsibilities include:
 - Invokes actions received from the client and handles effects from the <a href="https://github.com/aranya-project/aranya-core" target="_blank">Aranya Core</a> library. See the [walkthrough]({{ site.url }}/getting-started/walkthrough/) for more details.
 - Generates and maintains cryptographic keys for encrypting and decrypting data for Aranya and Fast Channels.
 
-
-
 ## Rust API docs
 - <a href="https://docs.rs/aranya-client/latest/aranya_client/" target="_blank">Aranya Client API docs</a>
 - <a href="https://docs.rs/aranya-daemon/latest/aranya_daemon/" target="_blank">Aranya Daemon API docs</a>
 
+## Rust example
+There is a <a href="{{ gh_aranya_url }}/blob/main/templates/aranya-example/README.md" target="_blank">Rust example</a> application that runs a `cargo-generate` template to give a quick way to get up and running. During setup, the example application starts an instance of the aranya-daemon for multiple Aranya user in the background. The daemon automatically handles syncing the Aranya graph states between peers so the Aranya client can focus on the operations it wants to perform on the team.
+
+The example app shows how to use the `aranya-client` library to:
+- Setup a team
+- Sync Aranya graphs
+- Create an Aranya Fast Channel
+- Send encrypted data between peers