From 85399669cc4e96996980b941458a0b6952154c03 Mon Sep 17 00:00:00 2001 From: Andrei Sandu Date: Thu, 17 Sep 2020 16:01:11 +0300 Subject: [PATCH] Update readme. Signed-off-by: Andrei Sandu --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 3a47917..571764a 100644 --- a/README.md +++ b/README.md @@ -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.