Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
leighmcculloch committed Nov 6, 2024
1 parent 5591528 commit d210141
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 7 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ build-fuzz:

readme:
cd soroban-sdk \
&& cargo +nightly rustdoc -- -Zunstable-options -wjson \
&& cargo +nightly rustdoc --features testutils -- -Zunstable-options -wjson \
&& cat ../target/doc/soroban_sdk.json \
| jq -r '.index[.root|tostring].docs' \
> README.md
Expand Down
19 changes: 14 additions & 5 deletions soroban-sdk/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,17 @@
Soroban SDK supports writing programs for the Soroban smart contract
platform.
Soroban SDK supports writing smart contracts for the [Soroban] smart contract
Wasm-powered runtime, that is deployed on [Stellar].

### Docs

See [soroban.stellar.org](https://soroban.stellar.org) for documentation.
See [developers.stellar.org] for documentation about building smart contracts for [Stellar].

[developers.stellar.org]: https://developers.stellar.org
[Stellar]: https://stellar.org
[Soroban]: https://stellar.org/soroban

### Migrating Major Versions

See [_migrating] for a summary of how to migrate from one major version to another.

### Examples

Expand Down Expand Up @@ -37,5 +45,6 @@ fn test() {
# fn main() { }
```

More examples are available at <https://soroban.stellar.org/docs/category/basic-tutorials>
and <https://soroban.stellar.org/docs/category/advanced-tutorials>.
More examples are available at:
- <https://developers.stellar.org/docs/build/smart-contracts/example-contracts>
- <https://developers.stellar.org/docs/build/guides>
4 changes: 3 additions & 1 deletion soroban-sdk/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
//! Soroban SDK supports writing smart contracts for Stellar.
//! Soroban SDK supports writing smart contracts for the [Soroban] smart contract
//! Wasm-powered runtime, that is deployed on [Stellar].
//!
//! ### Docs
//!
//! See [developers.stellar.org] for documentation about building smart contracts for [Stellar].
//!
//! [developers.stellar.org]: https://developers.stellar.org
//! [Stellar]: https://stellar.org
//! [Soroban]: https://stellar.org/soroban
//!
//! ### Migrating Major Versions
//!
Expand Down

0 comments on commit d210141

Please sign in to comment.