updated import info

2023-11-02 10:26:07 +01:00
parent 2334109721
commit 9a592df4f0
2 changed files with 20 additions and 3 deletions
@@ -21,11 +21,27 @@ The SDK is still somewhat a work in progress: interfaces are fairly stable but s
 ### Installation 
 The `nym-sdk` crate is **not yet available via [crates.io](https://crates.io)**. As such, in order to import the crate you must specify the Nym monorepo in your `Cargo.toml` file:

-TODO add note on branch import for stability - `master` should be last release 
 ```toml
 nym-sdk = { git = "https://github.com/nymtech/nym" }
 ```

+By default the above command will import the current `HEAD` of the default branch, which in our case is `develop`. Assuming instead you wish to pull in another branch (e.g. `master` or a particular release) you can specify this like so: 
+
+```toml
+# importing HEAD of master branch 
+nym-sdk = { git = "https://github.com/nymtech/nym", branch = "master" }
+# importing HEAD of the third release of 2023, codename 'kinder' 
+nym-sdk = { git = "https://github.com/nymtech/nym", branch = "release/2023.3-kinder" }
+```
+
+You can also define a particular git commit to use as your import like so: 
+
+```toml
+nym-sdk = { git = "https://github.com/nymtech/nym", rev = "85a7ec9f02ca8262d47eebb6c3b19d832341b55d" }
+```
+
+Since the `HEAD` of `master` is always the most recent release, we recommend developers use that for their imports, unless they have a reason to pull in a specific historic version of the code. 
+
 ### Generate Crate Docs 
 In order to generate the crate docs run `cargo doc --open` from `nym/sdk/rust/nym-sdk/`

@@ -1,3 +1,4 @@
 # Troubleshooting
-TODO note on poisson dance and not immediately killing client process 
-TODO note on listening for non-empty messages and point towards helpers 
+TODO note on 'task client is being dropped'
+TODO note on poisson dance and not immediately killing client process
+TODO note on listening for non-empty messages and point towards helpers