diff --git a/README.md b/README.md index f2a78fb..27ec967 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,10 @@ -# _storey_ +# storey -_storey_ is currently a pile of debris with some (hopefully) good ideas strewn about. One day, a new storage abstraction library for the decentralized world might rise from it. Like a phoenix from ashes. Or like a sleep-deprived commuter at 6 a.m. One of the two. +`storey` is currently a pile of debris with some (hopefully) good ideas strewn about. One day, a new storage abstraction library for the decentralized world might rise from it. Like a phoenix from ashes. Or like a sleep-deprived commuter at 6 a.m. One of the two. + +## Guide + +A (possibly still incomplete) guide can be found [here](https://docs.cosmwasm.com/storey). ## Loose goals (subject to change) diff --git a/packages/cw-storey/README.md b/packages/cw-storey/README.md index 0a120e9..611ba51 100644 --- a/packages/cw-storey/README.md +++ b/packages/cw-storey/README.md @@ -3,3 +3,5 @@ `cw-storey` is a crate providing storage abstractions for _CosmWasm_ smart contracts. It's an alternative to [`cw-storage-plus`](https://crates.io/crates/cw-storage-plus). The core logic lives in the [`storey`](https://crates.io/crates/storey) crate, while the `cw-storey` crate is an integration of `storey` with the `CosmWasm` storage interface. It also provides the recommended encoding for KV store values: [MessagePack](https://msgpack.org/index.html). + +A (possibly still incomplete) guide can be found [here](https://docs.cosmwasm.com/storey).