Skip to content

Commit ec14180

Browse files
committed
docs: update README
1 parent f91c745 commit ec14180

File tree

1 file changed

+4
-26
lines changed

1 file changed

+4
-26
lines changed

README.md

Lines changed: 4 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -51,21 +51,7 @@ async fn main() -> Result<(), Error> {
5151
}
5252
```
5353

54-
## Philosophy
55-
56-
We designed this SDK with predictability and safety in mind:
57-
58-
**Denial is not an error.** `check()` returns `Ok(false)` for denied access—never throws. Network failures are errors; permission denials are business logic.
59-
60-
**Fail-closed by default.** When something goes wrong, access is denied. Fail-open requires explicit opt-in.
61-
62-
**Results preserve order.** Batch operations return results matching input order—no ID correlation needed.
63-
64-
**Writes are acknowledged.** Write operations return only after server confirmation. No fire-and-forget surprises.
65-
66-
**Errors include request IDs.** Every server error exposes `request_id()` for debugging and support.
67-
68-
## Core API
54+
## Authorization API
6955

7056
### Authorization Checks
7157

@@ -133,6 +119,8 @@ let users = vault.subjects()
133119
.await?;
134120
```
135121

122+
## Management API
123+
136124
## Local Development
137125

138126
```rust
@@ -146,17 +134,7 @@ let client = Client::builder()
146134
.await?;
147135
```
148136

149-
```yaml
150-
# docker-compose.yml
151-
services:
152-
inferadb:
153-
image: ghcr.io/inferadb/inferadb:latest
154-
ports:
155-
- "8080:8080"
156-
environment:
157-
INFERADB__STORAGE__BACKEND: memory
158-
INFERADB__AUTH__SKIP_VERIFICATION: true
159-
```
137+
Run a local instance of InferaDB using [our deployment script](https://github.com/inferadb/deploy/).
160138

161139
## Testing
162140

0 commit comments

Comments
 (0)