docs: Short elaboration for each cargo-feature

Author: ickk

README.md

@@ -17,6 +17,8 @@ directories.
 it has a smaller inline-size; the inline data is a thin pointer like thin-vec.
 
 `SlimVec` implements as much of the API surface of `Vec` as possible.
+Additionally includes optional features for `arbitrary`, `borsh`, `comparable`,
+`serde`, & `valuable`.
 
 - [Overview](slimvec/docs/Overview.md)
 - [Features](slimvec/docs/Features.md)

slimvec/README.md

@@ -11,6 +11,8 @@
 it has a smaller inline-size; the inline data is a thin pointer like thin-vec.
 
 `SlimVec` implements as much of the API surface of `Vec` as possible.
+Additionally includes optional features for `arbitrary`, `borsh`, `comparable`,
+`serde`, & `valuable`.
 
 - [Overview](docs/Overview.md)
 - [Features](docs/Features.md)

slimvec/docs/Features.md

@@ -1,23 +1,60 @@
 The `slimvec` package includes the following cargo-features:
 
-### `std`
-
-Enables `std::io::Write` for `SlimVec<u8>`.
 
 ### `arbitrary`
 
-Enables support for [`arbitrary`].
-
 [`arbitrary`]: https://crates.io/crates/arbitrary
 
-### `serde`
+Enables support for constructing arbitrary values via [`arbitrary`].
+
+- Adds implementation of `arbitrary::Arbitrary` for `SlimVec<T: Arbitrary>`.
+
+
+### `borsh`
+
+[`borsh`]: https://crates.io/crates/borsh
+
+Enables support for serialisation & deserialisation via [`borsh`].
+
+- Adds implementation of `borsh::BorshSerialize` for
+  `SlimVec<T: BorshSerialize>`.
+- Adds implementation of `borsh::BorshDeserialize` for
+  `SlimVec<T: BorshDeserialize>`.
+
+
+### `comparable`
+
+[`comparable`]: https://crates.io/crates/comparable
+
+Enables support for structural comparison via [`comparable`].
+
+- Adds implementation of `comparable::Comparable` for `SlimVec<T: Comparable>`.
 
-Enables serialisation and deserialisation via [`serde`].
+
+### `serde`
 
 [`serde`]: https://crates.io/crates/serde
 
-### `valuable`
+Enables support for serialisation & deserialisation via [`serde`].
+
+- Adds implementation of `serde::Serialize` for `SlimVec<T: Serialize>`.
+- Adds implementation of `serde::Deserialize` for `SlimVec<T: Deserialize>`.
+
+
+### `std`
 
-Enables value inspect via [`valuable`].
+[Rust Standard Library]: https://doc.rust-lang.org/std
+
+Enables support for sinking byte streams via the [Rust Standard Library].
+
+- Adds implementation of `std::io::Write` for `SlimVec<u8>`.
+
+
+### `valuable`
 
 [`valuable`]: https://crates.io/crates/valuable
+
+Enables dyn-compatible value inspection via [`valuable`].
+
+- Adds implementation of `valuable::Valuable` for `SlimVec<T: Valuable>`.
+- Adds implementation of `valuable::Listable` for `SlimVec<T: Valuable>`.

slimvec/docs/Future-work.md

@@ -5,5 +5,3 @@ one-another.
 
 In the future `SlimVec` would like to add support for the currently unstable
 Rust features `allocator-api` & `#[may_dangle]`.
-
-Support for ecosystem Traits, e.g. serialisation, is also desirable.