From 1157bd5b650e026c2d540b3b2e91776b5f31b937 Mon Sep 17 00:00:00 2001 From: Yair <92672946+yair-starkware@users.noreply.github.com> Date: Thu, 13 Jul 2023 12:38:48 +0300 Subject: [PATCH] Add disclaimer for expected breaking changes in the storage (#847) --- crates/papyrus_storage/src/lib.rs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/crates/papyrus_storage/src/lib.rs b/crates/papyrus_storage/src/lib.rs index 39fcc7f6a0..a6a5e07bbc 100644 --- a/crates/papyrus_storage/src/lib.rs +++ b/crates/papyrus_storage/src/lib.rs @@ -4,6 +4,10 @@ //! database. Enables at most one writing operation and multiple reading operations concurrently. //! The underlying storage is implemented using the [`libmdbx`] crate. //! +//! # Disclaimer +//! This crate is still under development and is not keeping backwards compatibility with previous +//! versions. Breaking changes are expected to happen in the near future. +//! //! # Quick Start //! To use this crate, open a storage by calling [`open_storage`] to get a [`StorageWriter`] and a //! [`StorageReader`] and use them to create [`StorageTxn`] instances. The actual