Skip to content

Commit

Permalink
Update readme.
Browse files Browse the repository at this point in the history
Signed-off-by: Andrei Sandu <sandreim@amazon.com>
  • Loading branch information
sandreim committed Sep 17, 2020
1 parent 6c38633 commit 8539966
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,9 @@
# versionize

## Important note

This crate is currently used for cross-version serialization with the [Firecracker snapshot-restore dev preview](https://github.com/firecracker-microvm/firecracker/tree/v0.23.0), but has not been tested for other use cases. It should be considered **experimental software** outside the Firecracker context. It’s likely that this crate will see both interface and implementation changes in the future.

## Description

Provides version tolerant serialization and deserialization facilities and implements a persistent storage format for state snapshots.

0 comments on commit 8539966

Please sign in to comment.