Skip to content

Commit

Permalink
Add link to aranya-runtime crate
Browse files Browse the repository at this point in the history
This adds a link to the aranya-runtime crate, noting it can be used to
integrate Aranya as a library only.

This change also rearranges the information and notes at the top of the
walkthrough to make the information and links more concise.
  • Loading branch information
shannynat committed Jan 24, 2025
1 parent 16b1096 commit 4fbd82b
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/walkthrough.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ permalink: "/walkthrough/"

# Getting Started with Aranya

Note: The following walkthrough offers a detailed explanation of [Aranya](https://github.com/aranya-project/aranya/tree/main)'s internals, written in Rust, to assist in setting up an example usage. To run this scenario using Rust, see the [Rust template](https://github.com/aranya-project/aranya/tree/main/templates/aranya-example). To run this scenario using our C API wrappers, see the [C example](https://github.com/aranya-project/aranya/tree/main/examples/c).
In this document, we will walk through a scenario with five users initializing and running Aranya. The users will create a team using Aranya and send messages to each other using Aranya Fast Channels. To run this scenario using Rust, see the [Rust template](https://github.com/aranya-project/aranya/tree/main/templates/aranya-example). To run this scenario using our C API wrappers, see the [C example](https://github.com/aranya-project/aranya/tree/main/examples/c).

In this document, we will walk through a scenario with five users initializing
and running Aranya. The users will create a team using Aranya and send messages
to each other using Aranya Fast Channels. There are a few things to keep in mind:
There are a few things to note:

- The following walkthrough offers a detailed explanation of [Aranya](https://github.com/aranya-project/aranya/tree/main)'s internals, written in Rust, to assist in setting up an example usage with the [client](https://crates.io/crates/aranya-client) and [daemon](https://crates.io/crates/aranya-daemon). To integrate Aranya as a library only, use the [aranya-runtime](https://crates.io/crates/aranya-runtime).

- Any policy actions are determined by the implemented policy. This walkthrough
will use the default policy defined [here](https://github.com/aranya-project/aranya/blob/main/crates/aranya-daemon/src/policy.md).
Expand All @@ -23,7 +23,7 @@ to each other using Aranya Fast Channels. There are a few things to keep in mind
protected partition, such as an HSM, for maximum security. This avoids a
single access point for all Aranya user keys in case a machine is compromised.

See the [examples](https://github.com/aranya-project/aranya/tree/main/examples/) or [templates](https://github.com/aranya-project/aranya/tree/main/templates) directory for example applications that follow scenarios similar to the one described in this document. Also, see the [overview](https://aranya-project.github.io/aranya-docs/overview/) for more details on the components used in this walkthrough.
See the [overview](https://aranya-project.github.io/aranya-docs/overview/) for more details on the components used in this walkthrough.

# Outline

Expand Down

0 comments on commit 4fbd82b

Please sign in to comment.