Skip to content

Commit 3c8b347

Browse files
committed
update README
1 parent e061068 commit 3c8b347

File tree

1 file changed

+11
-12
lines changed

1 file changed

+11
-12
lines changed

README.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ A high-performance Rust-based platform for blockchain education and prototyping.
2424
- **High Performance**: Built with Rust for maximum performance and memory safety
2525
- **Educational Focus**: Well-documented code with clear explanations of blockchain concepts
2626
- **Modular Design**: Pluggable consensus mechanisms, storage backends, and network protocols
27-
- **Cryptographic Primitives**: Support for multiple signature schemes (Ed25519, ECDSA/secp256k1)
27+
- **Cryptographic Primitives**: Ed25519, ECDSA/secp256k1, VRF, Proof-of-Work, VDF, symmetric encryption (Fernet)
2828
- **Network Protocol**: P2P networking with peer discovery and message propagation
2929
- **Flexible Storage**: Memory and persistent storage options with optional SQLite indexing
3030
- **CLI Interface**: Easy-to-use command-line interface for node management
@@ -103,21 +103,20 @@ async fn main() -> Result<()> {
103103

104104
```rust
105105
use chaincraft_rust::{ChaincraftNode, Result};
106-
use chaincraft_rust::crypto::KeyType;
107106

108107
#[tokio::main]
109108
async fn main() -> Result<()> {
110109
let mut node = ChaincraftNode::builder()
111110
.port(21000)
112111
.max_peers(50)
113-
.enable_compression()
114-
.enable_persistent_storage()
115-
.key_type(KeyType::Ed25519)
112+
.with_persistent_storage(true) // requires feature "persistent"
113+
.local_discovery(true)
114+
.persist_peers(true)
116115
.build()?;
117116

118117
node.start().await?;
119118

120-
// Node is now running with persistent storage and compression enabled
119+
// Node is now running with persistent storage and local discovery
121120

122121
Ok(())
123122
}
@@ -204,13 +203,13 @@ chaincraft-rust = { version = "0.2.1", features = ["persistent", "indexing"] }
204203

205204
### Prerequisites
206205

207-
- Rust 1.70 or later
206+
- Rust 1.82 or later
208207
- Git
209208

210209
### Building
211210

212211
```bash
213-
git clone https://github.com/chaincraft-org/chaincraft-rust.git
212+
git clone https://github.com/jose-blockchain/chaincraft-rust.git
214213
cd chaincraft-rust
215214
cargo build
216215
```
@@ -224,8 +223,8 @@ cargo test
224223
# Run tests with all features enabled
225224
cargo test --all-features
226225

227-
# Run integration tests
228-
cargo test --test integration
226+
# Run example integration tests
227+
cargo test --test examples_integration
229228
```
230229

231230
### Running Benchmarks
@@ -272,7 +271,7 @@ cargo run --example shared_objects_example
272271

273272
## Contributing
274273

275-
We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
274+
We welcome contributions via pull requests.
276275

277276
### Development Workflow
278277

@@ -324,4 +323,4 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
324323

325324
---
326325

327-
For more information, visit our [documentation](https://docs.rs/chaincraft-rust) or [repository](https://github.com/chaincraft-org/chaincraft-rust).
326+
For more information, visit our [documentation](https://docs.rs/chaincraft-rust) or [repository](https://github.com/jose-blockchain/chaincraft-rust).

0 commit comments

Comments
 (0)