fix README, add license tags

Signed-off-by: Dave Huseby <[email protected]>

README.md

@@ -1,3 +1,45 @@
-# multiutil
+[![](https://img.shields.io/badge/made%20by-Cryptid%20Technologies-gold.svg?style=flat-square)][CRYPTID]
+[![](https://img.shields.io/badge/project-provenance-purple.svg?style=flat-square)][PROVENANCE]
+[![](https://img.shields.io/badge/project-multiformats-blue.svg?style=flat-square)][MULTIFORMATS]
+![](https://github.com/cryptidtech/multitrait/actions/workflows/rust.yml/badge.svg)
 
-Helpful traits, types, and functions for constructing multicodec types.
+# Multiutil
+
+Helpful traits, types, and functions for constructing multiformat types.
+
+## BaseEncoded
+
+The `BaseEncoded` "smart pointer" wraps any multiformat type that implements
+the `EncodingInfo` trait also found in this crate. `BaseEncoding` automatically
+handles base encoding the inner value using the [Multibase][MULTIBASE] text
+encoding systems.
+
+## CodecInfo
+
+The `CodecInfo` trait allows a multiformat type to expose its
+[Multicodec][MULTICODEC] value to code that relies on this trait.
+
+## Varuint
+
+This is an implementation of a [variable length, unsigned integer][VARUINT]
+that is common to all multiformat protocols and types.
+
+## Varbytes
+
+This is the combination of a `Varuint` followed by a binary octet array of
+equal length. This is a common way to encode arbitrary binary data so that any
+code can skip over the data if it doesn't know how, nor want, to process it
+
+```
+<varbytes> ::= <varuint> N(OCTET)
+                   ^        ^
+                  /          \
+          count of            variable number
+            octets            of octets
+```
+
+[CRYPTID]: https://cryptid.tech/
+[PROVENANCE]: https://github.com/cryptidtech/provenance-specifications/
+[MULTIFORMATS]: https://github.com/multiformats/multiformats/
+[MULTIBASE]: https://github.com/multiformats/multibase
+[VARUINT]: https://github.com/multiformats/unsigned-varint

src/base_encoded.rs

@@ -1,3 +1,4 @@
+// SPDX-License-Idnetifier: Apache-2.0
 use crate::{
     error::BaseEncodedError, prelude::Base, BaseEncoder, EncodingInfo, Error, DetectedEncoder,
 };

src/base_encoder.rs

@@ -1,3 +1,4 @@
+// SPDX-License-Idnetifier: Apache-2.0
 use crate::{
     base_name,
     error::{BaseEncodedError, BaseEncoderError},

src/base_name.rs

@@ -1,3 +1,4 @@
+// SPDX-License-Idnetifier: Apache-2.0
 use crate::prelude::Base;
 
 /// convert a multibase Base to its string equivalent

src/codec_info.rs

@@ -1,3 +1,4 @@
+// SPDX-License-Idnetifier: Apache-2.0
 use crate::prelude::Codec;
 
 /// This trait exposes the codec information for multicoded types

src/encoding_info.rs

@@ -1,3 +1,4 @@
+// SPDX-License-Idnetifier: Apache-2.0
 use crate::prelude::Base;
 
 /// This trait exposes the preferred encoding for this multicodec type

src/error.rs

@@ -1,3 +1,4 @@
+// SPDX-License-Idnetifier: Apache-2.0
 /// Errors generated by the numeric type impls
 #[derive(Clone, Debug, thiserror::Error)]
 #[non_exhaustive]

src/lib.rs

@@ -1,3 +1,4 @@
+// SPDX-License-Idnetifier: Apache-2.0
 //!
 #![warn(missing_docs)]
 #![deny(

src/serde/de.rs

@@ -1,3 +1,4 @@
+// SPDX-License-Idnetifier: Apache-2.0
 use crate::{BaseEncoded, BaseEncoder, EncodingInfo, Varbytes, Varuint};
 use core::{fmt, marker};
 use multibase::Base;

src/serde/mod.rs

@@ -1,3 +1,4 @@
+// SPDX-License-Idnetifier: Apache-2.0
 //! Serde (de)serialization for ['crate::prelude::Tagged'] wrapped objects
 mod de;
 mod ser;

src/serde/ser.rs

@@ -1,3 +1,4 @@
+// SPDX-License-Idnetifier: Apache-2.0
 use crate::{BaseEncoded, BaseEncoder, EncodingInfo, Varbytes, Varuint};
 use multitrait::prelude::EncodeInto;
 use serde::ser;

src/varbytes.rs

@@ -1,3 +1,4 @@
+// SPDX-License-Idnetifier: Apache-2.0
 use crate::{BaseEncoded, EncodingInfo, Error};
 use core::{fmt, ops};
 use multibase::Base;

src/varuint.rs

@@ -1,3 +1,4 @@
+// SPDX-License-Idnetifier: Apache-2.0
 use crate::{BaseEncoded, EncodingInfo, Error};
 use core::{fmt, ops};
 use multibase::Base;