Skip to content

Remove unnecessary information from README #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 8, 2025
Merged

Remove unnecessary information from README #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 2 additions & 26 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,6 @@

Swift bindings for FoundationDB, providing a native Swift API for interacting with FoundationDB clusters.

## Features

- **Native Swift API** - Idiomatic Swift interfaces for FoundationDB operations
- **Async/Await Support** - Modern Swift concurrency with async sequences
- **High Performance** - Optimized range iteration with background pre-fetching
- **Type Safety** - Swift's type system for safer database operations

## Quick Start

### Initialize the Client
Expand Down Expand Up @@ -66,26 +59,9 @@ try await database.withTransaction { transaction in
}
```

## Key Components

- **Transaction Management** - Automatic retry logic and conflict resolution
- **AsyncKVSequence** - Memory-efficient streaming iteration with background pre-fetching
- **Key Selectors** - Flexible key positioning for range queries
- **Atomic Operations** - Built-in atomic mutations (ADD, AND, OR, etc.)
- **Network Options** - Configurable client behavior and performance tuning

## Performance

The bindings include several performance optimizations:

- **Background Pre-fetching** - Range queries pre-fetch next batch while processing current data
- **Streaming Results** - Large result sets don't require full buffering in memory
- **Connection Pooling** - Efficient connection management to FoundationDB clusters
- **Configurable Batching** - Tunable batch sizes for optimal throughput

## Requirements

- Swift 5.7+
- Swift 6.0+
- FoundationDB 7.1+
- macOS 12+ / Linux

Expand All @@ -105,4 +81,4 @@ For detailed API documentation and advanced usage patterns, see the inline docum

## License

Licensed under the Apache License, Version 2.0. See LICENSE for details.
Licensed under the Apache License, Version 2.0. See LICENSE for details.