From 500b09ea09e5ddcb4377fe229ee765b7f5843788 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thoralf=20M=C3=BCller?= Date: Wed, 6 Sep 2023 10:15:31 +0200 Subject: [PATCH] Clean readmes --- README.md | 12 ++---------- bindings/python/README.md | 12 ++---------- 2 files changed, 4 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 584846b15e..c0df14bca9 100644 --- a/README.md +++ b/README.md @@ -117,21 +117,13 @@ iota-sdk = { git = "https://github.com/iotaledger/iota-sdk", branch = "develop" ## Client Usage -The following example creates a [`Client`](https://docs.rs/iota-sdk/latest/iota_sdk/client/core/struct.Client.html) -instance connected to -the [Shimmer Testnet](https://api.testnet.shimmer.network), and retrieves the node's information by -calling [`Client.get_info()`](https://docs.rs/iota-sdk/latest/iota_sdk/client/core/struct.Client.html#method.get_info), -and then print the node's information. +The following example creates a Client instance connected to the Shimmer Testnet, and retrieves the node's information by calling `Client.get_info()`, and then print the node's information. [sdk/examples/client/getting_started.rs](sdk/examples/client/getting_started.rs) ## Wallet Usage -The following example will create a -new [`Wallet`](https://docs.rs/iota-sdk/latest/iota_sdk/wallet/core/struct.Wallet.html) [`Account`](https://docs.rs/iota-sdk/latest/iota_sdk/wallet/account/struct.Account.html) -that connects to the [Shimmer Testnet](https://api.testnet.shimmer.network) using the -[`StrongholdSecretManager`](https://docs.rs/iota-sdk/latest/iota_sdk/client/secret/stronghold/type.StrongholdSecretManager.html) -to store a mnemonic. For this `features = ["stronghold"]` is needed in the Cargo.toml import. To persist the wallet in a database, `"rocksdb"` can be added. +The following example will create a new Wallet Account using a StrongholdSecretManager. For this `features = ["stronghold"]` is needed in the Cargo.toml import. To persist the wallet in a database, `"rocksdb"` can be added. [sdk/examples/wallet/getting_started.rs](sdk/examples/wallet/getting_started.rs) diff --git a/bindings/python/README.md b/bindings/python/README.md index f73adfc047..ada5663e67 100644 --- a/bindings/python/README.md +++ b/bindings/python/README.md @@ -60,21 +60,13 @@ Python binding to the [iota-sdk library](/README.md). ## Client Usage -The following example creates a [`Client`](https://wiki.iota.org/shimmer/iota-sdk/references/python/iota_sdk/client/) -instance connected to -the [Shimmer Testnet](https://api.testnet.shimmer.network), and retrieves the node's information by -calling [`Client.get_info()`](https://wiki.iota.org/shimmer/iota-sdk/references/python/iota_sdk/client/_node_core_api/#get_info), -and then print the node's information. +The following example creates a Client instance connected to the Shimmer Testnet, and retrieves the node's information by calling `Client.get_info()`, and then print the node's information. [examples/client/getting_started.py](examples/client/getting_started.py) ## Wallet Usage -The following example will create a -new [`Wallet`](https://wiki.iota.org/shimmer/iota-sdk/references/python/iota_sdk/wallet/) [`Account`](https://wiki.iota.org/shimmer/iota-sdk/references/python/iota_sdk/wallet/account/) -that connects to the [Shimmer Testnet](https://api.testnet.shimmer.network) using the -[`StrongholdSecretManager`](https://wiki.iota.org/shimmer/iota-sdk/references/python/iota_sdk/secret_manager/#strongholdsecretmanager-objects) -to safely store a seed derived from a mnemonic, and then print the account's information. +The following example will create a new Wallet Account using a StrongholdSecretManager, and then print the account's information. [examples/wallet/getting_started.py](examples/wallet/getting_started.py)