From 8ad9a38e7eda2198934e7e5426d95d4bd84fb9bc Mon Sep 17 00:00:00 2001 From: MozirDmitriy Date: Fri, 10 Jan 2025 20:14:29 +0300 Subject: [PATCH] Update README.md --- crates/sdk/README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/crates/sdk/README.md b/crates/sdk/README.md index 0e06ead87..5f5b01b69 100644 --- a/crates/sdk/README.md +++ b/crates/sdk/README.md @@ -22,3 +22,34 @@ Add the SDK to your project's `Cargo.toml`: [dependencies] sp1-sdk = { git = "https://github.com/succinctlabs/sp1.git" } ``` + +## Example + +Here's a simple example of using the SP1 SDK: + +```rust +use sp1_sdk::prelude::*; + +#[sp1_program] +fn example_program(x: u64, y: u64) -> u64 { + x + y +} +``` + +## Components + +The SDK includes: + +- Program attribute macros +- Precompile interfaces +- Type definitions and traits +- Helper functions and utilities +- Testing frameworks + +## Related Components + +- `sp1-zkvm`: The underlying VM implementation +- `sp1-core`: Core primitives and utilities +- `sp1-prover`: Proof generation system + +For detailed guides and examples, visit the [SP1 documentation](https://docs.succinct.xyz/)