Skip to content

Commit

Permalink
add hashers note in readme
Browse files Browse the repository at this point in the history
It's not evidently clear that the hashers need to be explicitly "added" so this readme note is an attempt to correct that.
  • Loading branch information
DougAnderson444 committed Jan 5, 2025
1 parent 5fef10c commit cdc1d22
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,18 @@ Check out the [examples](./examples).
- **Libp2p Integration**: Designed to integrate smoothly with libp2p, allowing it to be used in a wide range of decentralized applications.
- **Rust Safety and Performance**: Takes advantage of Rust's memory safety guarantees and performance optimizations, making it a robust choice for networked applications.

### Hasher Choices

Beetswap uses [multihash-codetable](https://docs.rs/crate/multihash-codetable/latest/features), so hashers can be enabled with the corresponding feature:

```toml
# your crate's Cargo.toml
# Say we want CIDs that used blake3 or sha2 or sha3
multihash-codetable = { version = "0.1", features = ["blake3", "sha2", "sha3"] }
```

Beyond the multihash codetable hashers, other custom hashers can be added, see [multihasher](./src/multihasher.rs) for further details.

## Contributing

We welcome contributions! Please fork the repository and submit a pull request.
Expand Down

0 comments on commit cdc1d22

Please sign in to comment.