Improve docs for encryption

bitcoinppl · Jul 29, 2024 · 4a554e2 · 4a554e2
1 parent b591935
commit 4a554e2
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -41,7 +41,10 @@ use bip329::{Labels, encryption::EncryptedLabels};
 
 let labels = Labels::try_from_file("tests/data/labels.jsonl").unwrap();
 let encrypted = EncryptedLabels::encrypt(&labels, "passphrase").unwrap();
-let decrypted: Labels = encrypted.decrypt("passphrase").unwrap();
+
+let encrypted = EncryptedLabels::read_from_file("tests/data/encrypted_labels.age").unwrap();
+let decrypted = encrypted.decrypt("passphrase").unwrap();
+assert_eq!(labels, decrypted);
 ```
 
 <!-- cargo-rdme end -->
diff --git a/src/lib.rs b/src/lib.rs
@@ -30,7 +30,10 @@
 //!
 //! let labels = Labels::try_from_file("tests/data/labels.jsonl").unwrap();
 //! let encrypted = EncryptedLabels::encrypt(&labels, "passphrase").unwrap();
-//! let decrypted: Labels = encrypted.decrypt("passphrase").unwrap();
+//!
+//! let encrypted = EncryptedLabels::read_from_file("tests/data/encrypted_labels.age").unwrap();
+//! let decrypted = encrypted.decrypt("passphrase").unwrap();
+//! assert_eq!(labels, decrypted);
 //! ```
 //!
 pub mod error;