From 23b9b6741fe7f35e90e84c2e8b3ec15e6904586a Mon Sep 17 00:00:00 2001 From: Tibor Bodecs Date: Fri, 16 Jan 2026 19:37:00 +0100 Subject: [PATCH 1/4] update readme --- Package.resolved | 2 +- README.md | 14 +++++++++----- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/Package.resolved b/Package.resolved index 3ab0e4b..302fb24 100644 --- a/Package.resolved +++ b/Package.resolved @@ -1,5 +1,5 @@ { - "originHash" : "7ea0e5162333b48310bed341461ed978d435b3058ac0b32d03f52382f2a35289", + "originHash" : "c53cc5c1c2fbb0ee02d11bdb535ac1cda535ae45702cb725841045235f9c3aef", "pins" : [ { "identity" : "swift-log", diff --git a/README.md b/README.md index 4e23388..9019380 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,22 @@ # Feather Database -![DocC API documentation](https://img.shields.io/badge/DocC-API_documentation-F05138) -![Platforms: Linux, macOS, iOS, tvOS, watchOS, visionOS](https://img.shields.io/badge/Platforms-Linux_%7C_macOS_%7C_iOS_%7C_tvOS_%7C_watchOS_%7C_visionOS-F05138) -![Swift 6.1+](https://img.shields.io/badge/Swift-6%2E1%2B-F05138) -![Release: 1.0.0-beta.1](https://img.shields.io/badge/Release-1%2E0%2E0--beta%2E1-F05138) +Abstract database component, providing a shared API surface for database drivers written in Swift. -Abstract database component for Feather CMS, providing a shared API surface for database drivers written in Swift. +![Release: 1.0.0-beta.1](https://img.shields.io/badge/Release-1%2E0%2E0--beta%2E1-F05138) ## Features + + - 🤝 Database-agnostic abstraction layer - 🔀 Designed for modern Swift concurrency - 📚 API Documentation is available using DocC - ✅ Code coverage and unit tests ## Requirements + +![Swift 6.1+](https://img.shields.io/badge/Swift-6%2E1%2B-F05138) +![Platforms: Linux, macOS, iOS, tvOS, watchOS, visionOS](https://img.shields.io/badge/Platforms-Linux_%7C_macOS_%7C_iOS_%7C_tvOS_%7C_watchOS_%7C_visionOS-F05138) - Swift 6.1+ - Swift Package Manager @@ -42,6 +44,8 @@ Then add `FeatherDatabase` to your target dependencies: ## Usage +![DocC API documentation](https://img.shields.io/badge/DocC-API_documentation-F05138) + > [!TIP] > Avoid calling `database.execute` while in a transaction; use the transaction `connection` instead. From 25946acdaa193c3fdc26c0359ea531845455e918 Mon Sep 17 00:00:00 2001 From: Tibor Bodecs Date: Fri, 16 Jan 2026 19:42:12 +0100 Subject: [PATCH 2/4] readme changes --- README.md | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 9019380..e2ee0fe 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,6 @@ Abstract database component, providing a shared API surface for database drivers ## Features - - - 🤝 Database-agnostic abstraction layer - 🔀 Designed for modern Swift concurrency - 📚 API Documentation is available using DocC @@ -19,7 +17,7 @@ Abstract database component, providing a shared API surface for database drivers ![Platforms: Linux, macOS, iOS, tvOS, watchOS, visionOS](https://img.shields.io/badge/Platforms-Linux_%7C_macOS_%7C_iOS_%7C_tvOS_%7C_watchOS_%7C_visionOS-F05138) - Swift 6.1+ -- Swift Package Manager + - Platforms: - Linux - macOS 15+ @@ -30,28 +28,39 @@ Abstract database component, providing a shared API surface for database drivers ## Installation -Add the dependency to your `Package.swift`: +Use Swift Package Manager; add the dependency to your `Package.swift` file: ```swift -.package(url: "https://github.com/feather-framework/feather-database", exact: "1.0.0-beta.1") +.package(url: "https://github.com/feather-framework/feather-database", exact: "1.0.0-beta.1"), ``` Then add `FeatherDatabase` to your target dependencies: ```swift -.product(name: "FeatherDatabase", package: "feather-database") +.product(name: "FeatherDatabase", package: "feather-database"), ``` ## Usage - + ![DocC API documentation](https://img.shields.io/badge/DocC-API_documentation-F05138) +API documentation is available at the following link. Refer to the mock objects in the Tests directory if you want to build a custom database driver implementation. + > [!TIP] > Avoid calling `database.execute` while in a transaction; use the transaction `connection` instead. > [!WARNING] > This repository is a work in progress, things can break until it reaches v1.0.0. + +## Database drivers + +The following database driver implementations are available for use: + +- [SQLite](https://github.com/feather-framework/feather-sqlite-database) +- [Postgres](https://github.com/feather-framework/feather-postgres-database) +- [MySQL](https://github.com/feather-framework/feather-mysql-database) + ## Development - Build: `swift build` @@ -59,6 +68,7 @@ Then add `FeatherDatabase` to your target dependencies: - Format: `make format` - Check: `make check` + ## Contributing Pull requests are welcome. Please keep changes focused and include tests for new logic. From b7e3020178633f7901e73e534d03f0c9f0ab76f8 Mon Sep 17 00:00:00 2001 From: Tibor Bodecs Date: Fri, 16 Jan 2026 19:43:57 +0100 Subject: [PATCH 3/4] minor changes --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e2ee0fe..bdb4063 100644 --- a/README.md +++ b/README.md @@ -64,11 +64,12 @@ The following database driver implementations are available for use: ## Development - Build: `swift build` -- Test: `swift test` +- Test: + - local: `swift test` + - using Docker: `swift docker-test` - Format: `make format` - Check: `make check` - ## Contributing -Pull requests are welcome. Please keep changes focused and include tests for new logic. +[Pull requests](https://github.com/feather-framework/feather-database/pulls) are welcome. Please keep changes focused and include tests for new logic. From 9cbcfaf36bc15a58746722f340073f148098b801 Mon Sep 17 00:00:00 2001 From: Tibor Bodecs Date: Fri, 16 Jan 2026 19:45:33 +0100 Subject: [PATCH 4/4] fixes --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index bdb4063..a4cc4fc 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,8 @@ Abstract database component, providing a shared API surface for database drivers - 🤝 Database-agnostic abstraction layer - 🔀 Designed for modern Swift concurrency -- 📚 API Documentation is available using DocC -- ✅ Code coverage and unit tests +- 📚 DocC-based API Documentation +- ✅ Unit tests and code coverage ## Requirements @@ -72,4 +72,4 @@ The following database driver implementations are available for use: ## Contributing -[Pull requests](https://github.com/feather-framework/feather-database/pulls) are welcome. Please keep changes focused and include tests for new logic. +[Pull requests](https://github.com/feather-framework/feather-database/pulls) are welcome. Please keep changes focused and include tests for new logic. 🙏