Skip to content

Commit ecbc609

Browse files
author
Bennett Hardwick
committed
Update docs
1 parent 6dbcc25 commit ecbc609

File tree

2 files changed

+11
-6
lines changed

2 files changed

+11
-6
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,11 @@ Upload it to ZeroKMS using the following command:
5353

5454
<!-- cargo-rdme start -->
5555

56+
## Cryptonamo: Encrypted Tables for DynamoDB
57+
58+
Based on the CipherStash SDK and ZeroKMS key service, Cryptonamo provides a simple interface for
59+
storing and retrieving encrypted data in DynamoDB.
60+
5661
## Usage
5762

5863
To use Cryptonamo, you must first create a table in DynamoDB.
@@ -82,8 +87,8 @@ See below for more information on schema design for Cryptonamo tables.
8287

8388
### Annotating a Cryptanomo Type
8489

85-
To use Cryptonamo, you must first annotate a struct with the `Encryptable` derive macro, as
86-
well as the `Searchable` and `Decryptable` macros if you want to support those features.
90+
To use Cryptonamo, you must first annotate a struct with the `Encryptable`, `Searchable` and
91+
`Decryptable` derive macros.
8792

8893
```rust
8994
use cryptonamo::{Searchable, Decryptable, Encryptable};
@@ -208,7 +213,7 @@ You can also specify a compound index by using the `compound` attribute.
208213
Indexes with the same name will be combined into the one index.
209214

210215
Compound index names must be a combination of field names separated by a #.
211-
Fields mentioned in the compound index name that aren't correctly annottated will result in a
216+
Fields mentioned in the compound index name that aren't correctly annotated will result in a
212217
compilation error.
213218

214219
```rust

src/lib.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@
3333
//!
3434
//! ### Annotating a Cryptanomo Type
3535
//!
36-
//! To use Cryptonamo, you must first annotate a struct with the `Encryptable` derive macro, as
37-
//! well as the `Searchable` and `Decryptable` macros if you want to support those features.
36+
//! To use Cryptonamo, you must first annotate a struct with the `Encryptable`, `Searchable` and
37+
//! `Decryptable` derive macros.
3838
//!
3939
//! ```rust
4040
//! use cryptonamo::{Searchable, Decryptable, Encryptable};
@@ -159,7 +159,7 @@
159159
//! Indexes with the same name will be combined into the one index.
160160
//!
161161
//! Compound index names must be a combination of field names separated by a #.
162-
//! Fields mentioned in the compound index name that aren't correctly annottated will result in a
162+
//! Fields mentioned in the compound index name that aren't correctly annotated will result in a
163163
//! compilation error.
164164
//!
165165
//! ```rust

0 commit comments

Comments
 (0)