Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Add note about hashers in readme #60

Merged
merged 2 commits into from
Jan 7, 2025
Merged

chore: Add note about hashers in readme #60

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cdc1d22
add hashers note in readme
DougAnderson444 Jan 5, 2025
ffc2f5a
don't check missing docs in tests
zvolin Jan 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
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
Loading