Skip to content

Commit

Permalink
Add blurb about official docs to READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
uint committed Sep 11, 2024
1 parent b945707 commit 4f539c8
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)

Expand Down
2 changes: 2 additions & 0 deletions packages/cw-storey/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

0 comments on commit 4f539c8

Please sign in to comment.