Merge pull request #25 from MathiasKoch/release/docs

Add Changelog entry and readme section

CHANGELOG.md

@@ -10,6 +10,8 @@
   method already existed but now comes from the `std::convert::TryFrom` trait.
 * `encode()` now takes anything that implements the `BufMut` trait, not just a `ByteMut` struct. For
   technical reasons, `decode()` still takes `BytesMut`.
+* Added option to opt-out of std library, allowing usage in `#[no_std]` projects, at the only cost
+  of giving up the `Error` trait from std as well as `std::io` integration.
 
 ## Bugfixes
 

Cargo.toml

@@ -2,15 +2,16 @@
 name = "mqttrs"
 version = "0.2.0"
 authors = ["00imvj00 <vijaybambhaniya007@gmail.com>",
-           "Vincent de Phily <moltonel@gmail.com>"]
+           "Vincent de Phily <moltonel@gmail.com>",
+           "Mathias Koch <smilykoch@gmail.com>"]
 edition = "2018"
 description = "Mqtt protocol encoding and decoding"
 readme = "README.md"
 homepage = "https://github.com/00imvj00/mqttrs"
 repository = "https://github.com/00imvj00/mqttrs"
 documentation = "https://docs.rs/mqttrs"
 keywords = ["mqtt", "pubsub", "publish-subscribe", "codec"]
-categories = ["encoding", "network-programming"]
+categories = ["encoding", "network-programming", "no-std"]
 license = "Apache-2.0"
 
 [features]

README.md

@@ -57,3 +57,12 @@ subscriptions...).
 
 This doesn't add mqtt as a serde data format; you still need to use the `mqttrs::{decode,encode}`
 functions.
+
+## Optional `#[no_std]` support.
+
+Use `mqttrs = { version = "0.2", default-features = false }` in your `Cargo.toml` to remove the
+default `std` feature.
+
+Disabling this feature comes with the cost of not implementing the `std::error::Error` trait,
+as well as not supporting `std::io` read and write. This allows usage in embedded devices
+where the standard library is not available.