From 80fb5098abba04b972be65d6a8c098a63ff29bb9 Mon Sep 17 00:00:00 2001 From: Dave Huseby Date: Sun, 7 Apr 2024 16:02:42 -0600 Subject: [PATCH] clean README for clarity Signed-off-by: Dave Huseby --- README.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 17e19a8..06bcc72 100644 --- a/README.md +++ b/README.md @@ -5,13 +5,17 @@ # Multihash -Multiformats multihash implementation without size in the type signature. Uses -the [`multiutil::BaseEncoded`] smart pointers to wrap the Multihash into -EncodecMultihash for base encoded multihashes. This automates the -encoding/decoding to/from strings and byte slices for multihashes. It also has -serde support to/from human readable and binary formats. It also supports raw -binary encoding and decoding using [`Into>`] and [`TryFrom<&[u8]>`] -trait implementations. +Multiformats [Multihash][MULTIHASH] implementation without constant size in the +type signature. + +## Features + +* Uses the [`multiutil::BaseEncoded`] smart pointers to wrap the Multihash into + EncodecMultihash for base encoded multihashes; automating the + encoding/decoding to/from strings and byte slices. +* Serde support to/from human readable and binary formats. +* Supports raw binary encoding and decoding using [`Into>`] and + [`TryFrom<&[u8]>`] trait implementations. ## Examples @@ -47,3 +51,4 @@ let encoded_mh2: EncodedMultihash::new(Base::Base32Upper, mh); [CRYPTID]: https://cryptid.tech/ [PROVENANCE]: https://github.com/cryptidtech/provenance-specifications/ [MULTIFORMATS]: https://github.com/multiformats/multiformats/ +[MULTIHASH]: https://www.multiformats.io/multihash/