Document the purpose of the streaming API

jedisct1 · Oct 11, 2022 · c8bef50 · c8bef50
1 parent 09525ee
commit c8bef50
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -55,7 +55,7 @@ println!("Signature as bytes: {:?}", signature_as_bytes);
 
 ## Incremental API example usage
 
-Messages can also be supplied as multiple parts (streaming API):
+Messages can also be supplied as multiple parts (streaming API) in order to handle large messages without using much memory:
 
 ```rust
 /// Creates a new key pair.

diff --git a/src/lib.rs b/src/lib.rs
@@ -44,7 +44,8 @@
 //!
 //! ## Incremental API example usage
 //!
-//! Messages can also be supplied as multiple parts (streaming API):
+//! Messages can also be supplied as multiple parts (streaming API) in order to
+//! handle large messages without using much memory:
 //!
 //! ```rust
 //! use ed25519_compact::*;