From d5953c28c1cf7dd91abdac2eb00fa60f99bcdb37 Mon Sep 17 00:00:00 2001 From: mx Date: Fri, 28 Apr 2023 15:45:38 +0200 Subject: [PATCH] added note on running example code --- documentation/docs/src/sdk/rust.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/docs/src/sdk/rust.md b/documentation/docs/src/sdk/rust.md index c8c0cb1c14..0763c9eb9b 100644 --- a/documentation/docs/src/sdk/rust.md +++ b/documentation/docs/src/sdk/rust.md @@ -27,7 +27,7 @@ The `mixnet` component currently exposes the logic of two clients: the websocket The `coconut` component is currently being worked on. Right now it exposes logic allowing for the creation of coconut credentials on the Sandbox testnet. ## Websocket client examples -> All the codeblocks below can be found in the `nym-sdk` [examples directory](https://github.com/nymtech/nym/tree/release/{{platform_release_version}}/sdk/rust/nym-sdk/examples) in the monorepo. +> All the codeblocks below can be found in the `nym-sdk` [examples directory](https://github.com/nymtech/nym/tree/release/{{platform_release_version}}/sdk/rust/nym-sdk/examples) in the monorepo. Just navigate to `nym/sdk/rust/nym-sdk/examples/` and run the files from there. If you wish to run these outside of the workspace - such as if you want to use one as the basis for your own project - then make sure to import the `sdk` and the `nym_bin_common` crates. Lets look at a very simple example of how you can import and use the websocket client in a piece of Rust code (`examples/simple.rs`):