Skip to content

Commit

Permalink
Add disclaimer for expected breaking changes in the storage (#847)
Browse files Browse the repository at this point in the history
  • Loading branch information
yair-starkware authored Jul 13, 2023
1 parent 427dd8e commit 1157bd5
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions crates/papyrus_storage/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 1157bd5

Please sign in to comment.