Preparations for v0.3 release

Cargo.toml

@@ -1,14 +1,14 @@
 [package]
 name = "ordpath"
-version = "0.2.0"
+version = "0.3.0"
 authors = ["Yoh Deadfall <[email protected]>"]
 edition = "2021"
 homepage = "https://github.com/yohdeadfall/ordpath/"
 repository = "https://github.com/yohdeadfall/ordpath/"
-description = "Implementation of ORDPATH encoding"
+description = "Implementation of the ORDPATH hierarchical labeling scheme"
 license = "MIT OR Apache-2.0"
 readme = "README.md"
-keywords = ["encoding", "ordering", "hierarchy"]
+keywords = ["encoding", "ordering", "hierarchy", "labeling"]
 categories = ["encoding"]
 exclude = [".github/"]
 

README.md

@@ -1,3 +1,12 @@
 # ordpath
 
-A hierarchy labeling scheme called ORDPATH.
+ORDPATH is a hierarchical labeling scheme.
+
+The crate provides low and high level APIs for reading, writing an manipulating ORDPATH bitstrings.
+
+## License
+
+The code in this repository is dual licensed under either:
+
+* MIT License ([LICENSE-MIT](see LICENSE-MIT))
+* Apache License, Version 2.0 (see [LICENSE-APACHE](LICENSE-APACHE))

src/enc.rs

@@ -80,7 +80,7 @@ impl fmt::Debug for Stage {
     }
 }
 
-/// An implementation of `Alloctor` is responsible for providing a [`Stage`]
+/// An implementation of `Encoding` is responsible for providing a [`Stage`]
 /// for the provided value or prefix.
 pub trait Encoding: PartialEq + Eq {
     /// Returns a reference to the [`Stage`] corresponding to the prefix.