Skip to content

Commit 0b92671

Browse files
committed
docs: update README
1 parent f4be50a commit 0b92671

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@
1919

2020
## Quick Start
2121

22+
Add the [inferadb](https://crates.io/crates/inferadb) crate to your `Cargo.toml`:
23+
2224
```toml
2325
[dependencies]
2426
inferadb = "0.1"
@@ -47,15 +49,19 @@ async fn main() -> Result<(), Error> {
4749
}
4850
```
4951

50-
## Design Guarantees
52+
## Philosophy
53+
54+
We designed this SDK with predictability and safety in mind:
55+
56+
**Denial is not an error.** `check()` returns `Ok(false)` for denied access—never throws. Network failures are errors; permission denials are business logic.
57+
58+
**Fail-closed by default.** When something goes wrong, access is denied. Fail-open requires explicit opt-in.
59+
60+
**Results preserve order.** Batch operations return results matching input order—no ID correlation needed.
61+
62+
**Writes are acknowledged.** Write operations return only after server confirmation. No fire-and-forget surprises.
5163

52-
| Guarantee | Description |
53-
| ------------------------------ | ------------------------------------------------------------------------------------------ |
54-
| **Denial is not an error** | `check()` returns `Ok(false)` for denied access; only `require()` converts denial to error |
55-
| **Fail-closed by default** | Errors default to denying access; fail-open must be explicit |
56-
| **Results preserve order** | Batch operations return results in the same order as inputs |
57-
| **Writes are acknowledged** | Write operations complete only after server confirmation. |
58-
| **Errors include request IDs** | All server errors expose a request_id() for debugging and support. |
64+
**Errors include request IDs.** Every server error exposes `request_id()` for debugging and support.
5965

6066
## Core API
6167

0 commit comments

Comments
 (0)