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

Jump to bottom

docs: fix some outdated links and descriptions #13

Merged
merged 1 commit into from
Mar 1, 2017
Merged

docs: fix some outdated links and descriptions #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ license = "MIT"

readme = "README.md"

documentation = "https://docs.rs/multihash/"

[dependencies]
tiny-keccak = "~1.0.5"
ring = "~0.6.2"
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](https://webchat.freenode.net/?channels=%23ipfs)
[![Travis CI](https://img.shields.io/travis/multiformats/rust-multihash.svg?style=flat-square&branch=master)](https://travis-ci.org/multiformats/rust-multihash)
[![codecov.io](https://img.shields.io/codecov/c/github/multiformats/rust-multihash.svg?style=flat-square&branch=master)](https://codecov.io/github/multiformats/rust-multihash?branch=master)
[![](https://img.shields.io/badge/rust-docs-blue.svg?style=flat-square)](https://multiformats.github.io/rust-multihash/multihash/struct.Multihash.html)
[![](https://img.shields.io/badge/rust-docs-blue.svg?style=flat-square)](https://docs.rs/multihash/)
[![crates.io](https://img.shields.io/badge/crates.io-v0.4.0-orange.svg?style=flat-square )](https://crates.io/crates/multihash)
[![](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)

Expand Down Expand Up @@ -48,6 +48,7 @@ let multi = decode(&hash).unwrap();
* `SHA1`
* `SHA2-256`
* `SHA2-512`
* `SHA3`/`Keccak`

## Maintainers

Expand Down
10 changes: 5 additions & 5 deletions src/hashes.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ use errors::Error;
/// Not all hash types are supported by this library.
#[derive(PartialEq, Eq, Clone, Debug, Copy)]
pub enum Hash {
/// Encoding unsupported
/// SHA-1 (20-byte hash size)
SHA1,
/// SHA-256 (32-byte hash size)
SHA2256,
Expand All @@ -19,13 +19,13 @@ pub enum Hash {
SHA3256,
/// SHA3-224 (28-byte hash size)
SHA3224,
// Keccak-224 (28-byte hash size)
/// Keccak-224 (28-byte hash size)
Keccak224,
// Keccak-256 (32-byte hash size)
/// Keccak-256 (32-byte hash size)
Keccak256,
// Keccak-384 (48-byte hash size)
/// Keccak-384 (48-byte hash size)
Keccak384,
// Keccak-512 (64-byte hash size)
/// Keccak-512 (64-byte hash size)
Keccak512,
/// Encoding unsupported
Blake2b,
Expand Down