update readme

README.md

@@ -32,13 +32,14 @@ decode), and is the default feature set.
 2. `alloc` – The alloc feature uses `Box` and `Vec` types for recursive
 references and arrays, and is automatically enabled if the std feature is
 enabled. The default global allocator is used. Support for a custom
-allocator will be added in [#39]. Encode or decode capability exists, but
-still in an experimental stage, there may be breaking changes at any time.
+allocator will be added in [#39]. No encode or decode capability exists,
+only types. Encode and decode capability will be added in [#46].
 3. If std or alloc are not enabled recursive and array types requires static
 lifetime values. No encode or decode capability exists. Encode and decode
 capability will be added in [#47].
 
 [#39]: https://github.com/stellar/rs-stellar-xdr/issues/39
+[#46]: https://github.com/stellar/rs-stellar-xdr/issues/46
 [#47]: https://github.com/stellar/rs-stellar-xdr/issues/47
 
 Ancillary functionality:
@@ -53,6 +54,9 @@ only necessary to use utility functions that depend on serde_json.
 5. `hex` – Enables support for hex in string representations of some types.
 Automatically enabled when serde is enabled.
 6. `schemars` – Enables support for JSON Schema generation. (Experimental)
+7. `embedded_io` - Enables support for encoding and decoding using the
+`embedded-io` library, without relying on `std::io`, making it suitable for
+`no_std` environments. (Experimental)
 
 Features marked experimental may disappear at anytime, see breaking changes
 at anytime, or and may be minimal implementations instead of complete.

src/lib.rs

@@ -5,8 +5,7 @@
 // auto-generated docs.
 #![allow(clippy::tabs_in_doc_comments)]
 #![allow(clippy::doc_markdown)]
-// TODO: Make clippy happy
-#![allow(clippy::doc_lazy_continuation)]
+
 //! Library and CLI containing types and functionality for working with Stellar
 //! XDR.
 //!
@@ -39,13 +38,14 @@
 //! 2. `alloc` – The alloc feature uses `Box` and `Vec` types for recursive
 //! references and arrays, and is automatically enabled if the std feature is
 //! enabled. The default global allocator is used. Support for a custom
-//! allocator will be added in [#39]. Encode or decode capability exists, but
-//! still in an experimental stage, there may be breaking changes at any time.
+//! allocator will be added in [#39]. No encode or decode capability exists,
+//! only types. Encode and decode capability will be added in [#46].
 //! 3. If std or alloc are not enabled recursive and array types requires static
 //! lifetime values. No encode or decode capability exists. Encode and decode
 //! capability will be added in [#47].
 //!
 //! [#39]: https://github.com/stellar/rs-stellar-xdr/issues/39
+//! [#46]: https://github.com/stellar/rs-stellar-xdr/issues/46
 //! [#47]: https://github.com/stellar/rs-stellar-xdr/issues/47
 //!
 //! Ancillary functionality:
@@ -60,6 +60,9 @@
 //! 5. `hex` – Enables support for hex in string representations of some types.
 //! Automatically enabled when serde is enabled.
 //! 6. `schemars` – Enables support for JSON Schema generation. (Experimental)
+//! 7. `embedded_io` - Enables support for encoding and decoding using the
+//! `embedded-io` library, without relying on `std::io`, making it suitable for
+//! `no_std` environments. (Experimental)
 //!
 //! Features marked experimental may disappear at anytime, see breaking changes
 //! at anytime, or and may be minimal implementations instead of complete.