Skip to content
Merged
Changes from all commits
Commits
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
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,11 @@

Abstract database component, providing a shared API surface for database drivers written in Swift.

[![Release: 1.0.0-beta.5](https://img.shields.io/badge/Release-1%2E0%2E0--beta%2E5-F05138)](https://github.com/feather-framework/feather-database/releases/tag/1.0.0-beta.5)
[
![Release: 1.0.0-rc.1](https://img.shields.io/badge/Release-1%2E0%2E0--rc%2E1-F05138)
](
https://github.com/feather-framework/feather-database/releases/tag/1.0.0-rc.1
)

## Features

Expand Down Expand Up @@ -31,7 +35,7 @@ Abstract database component, providing a shared API surface for database drivers
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.5"),
.package(url: "https://github.com/feather-framework/feather-database", exact: "1.0.0-rc.1"),
```

Then add `FeatherDatabase` to your target dependencies:
Expand All @@ -42,13 +46,14 @@ Then add `FeatherDatabase` to your target dependencies:

## Usage

[![DocC API documentation](https://img.shields.io/badge/DocC-API_documentation-F05138)](https://feather-framework.github.io/feather-database/)
[
![DocC API documentation](https://img.shields.io/badge/DocC-API_documentation-F05138)
](
https://feather-framework.github.io/feather-database/
)

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.

> [!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:
Expand Down
Loading