Merge bitcoindevkit#1661: chore(file_store): Document that it's a dev…

… database

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

Pull request description:

  Document `bdk_file_store` is a development/testing database

ACKs for top commit:
  LagginTimes:
    ACK 4b5bd0b
  ValuedMammal:
    ACK 4b5bd0b
  oleonardolima:
    ACK 4b5bd0b

Tree-SHA512: a374753fe3d367870afc7b4cb301ef7fd09da1babefb0601191b266123358c2ffd247e4c6c5fb84eaa0e3b2821f8c0b1337cde6d63bbc2dce3fb7d5ff0286cef

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.

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