chore(file_store): Document that it's a dev database

diff --git a/crates/file_store/README.md b/crates/file_store/README.md
index 7b00aa0e02a07fc2487168f46e09f088825a8ab5..5c4100b93a230123663fc6cd1ee3eb1840e8a219 100644 (file)
--- a/crates/file_store/README.md
+++ b/crates/file_store/README.md
@@ -1,5 +1,7 @@
 # BDK File Store
 
+> ⚠ `bdk_file_store` is a development/testing database. It does not natively support backwards compatible BDK version upgrades so should not be used in production.
+
 This is a simple append-only flat file database for persisting [`bdk_chain`] changesets.
 
 The main structure is [`Store`] which works with any [`bdk_chain`] based changesets to persist data into a flat file.

diff --git a/crates/file_store/src/store.rs b/crates/file_store/src/store.rs
index 49ddc77316113bde4f50c1858dbfdecfcb6b3f9c..ec86d4e5e6eb15b8c8e4ba511e40636e1cbd062a 100644 (file)
--- a/crates/file_store/src/store.rs
+++ b/crates/file_store/src/store.rs
@@ -10,6 +10,9 @@ use std::{
 };
 
 /// Persists an append-only list of changesets (`C`) to a single file.
+///
+/// > ⚠ This is a development/testing database. It does not natively support backwards compatible
+/// > BDK version upgrades so should not be used in production.
 #[derive(Debug)]
 pub struct Store<C>
 where