Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MozirDmitriy authored Jan 10, 2025
1 parent c6d0460 commit 8ad9a38
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions crates/sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/)

0 comments on commit 8ad9a38

Please sign in to comment.