Skip to content

Commit 34b05e9

Browse files
authored
Improve readme (#14)
1 parent 3665a93 commit 34b05e9

2 files changed

Lines changed: 29 additions & 14 deletions

File tree

Package.resolved

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

Lines changed: 28 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
# Feather Database
22

3-
![DocC API documentation](https://img.shields.io/badge/DocC-API_documentation-F05138)
4-
![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)
5-
![Swift 6.1+](https://img.shields.io/badge/Swift-6%2E1%2B-F05138)
6-
![Release: 1.0.0-beta.1](https://img.shields.io/badge/Release-1%2E0%2E0--beta%2E1-F05138)
3+
Abstract database component, providing a shared API surface for database drivers written in Swift.
74

8-
Abstract database component for Feather CMS, providing a shared API surface for database drivers written in Swift.
5+
![Release: 1.0.0-beta.1](https://img.shields.io/badge/Release-1%2E0%2E0--beta%2E1-F05138)
96

107
## Features
118

129
- 🤝 Database-agnostic abstraction layer
1310
- 🔀 Designed for modern Swift concurrency
14-
- 📚 API Documentation is available using DocC
15-
-Code coverage and unit tests
11+
- 📚 DocC-based API Documentation
12+
-Unit tests and code coverage
1613

1714
## Requirements
15+
16+
![Swift 6.1+](https://img.shields.io/badge/Swift-6%2E1%2B-F05138)
17+
![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)
1818

1919
- Swift 6.1+
20-
- Swift Package Manager
20+
2121
- Platforms:
2222
- Linux
2323
- macOS 15+
@@ -28,33 +28,48 @@ Abstract database component for Feather CMS, providing a shared API surface for
2828

2929
## Installation
3030

31-
Add the dependency to your `Package.swift`:
31+
Use Swift Package Manager; add the dependency to your `Package.swift` file:
3232

3333
```swift
34-
.package(url: "https://github.com/feather-framework/feather-database", exact: "1.0.0-beta.1")
34+
.package(url: "https://github.com/feather-framework/feather-database", exact: "1.0.0-beta.1"),
3535
```
3636

3737
Then add `FeatherDatabase` to your target dependencies:
3838

3939
```swift
40-
.product(name: "FeatherDatabase", package: "feather-database")
40+
.product(name: "FeatherDatabase", package: "feather-database"),
4141
```
4242

4343
## Usage
44+
45+
![DocC API documentation](https://img.shields.io/badge/DocC-API_documentation-F05138)
46+
47+
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.
4448

4549
> [!TIP]
4650
> Avoid calling `database.execute` while in a transaction; use the transaction `connection` instead.
4751
4852
> [!WARNING]
4953
> This repository is a work in progress, things can break until it reaches v1.0.0.
5054
55+
56+
## Database drivers
57+
58+
The following database driver implementations are available for use:
59+
60+
- [SQLite](https://github.com/feather-framework/feather-sqlite-database)
61+
- [Postgres](https://github.com/feather-framework/feather-postgres-database)
62+
- [MySQL](https://github.com/feather-framework/feather-mysql-database)
63+
5164
## Development
5265

5366
- Build: `swift build`
54-
- Test: `swift test`
67+
- Test:
68+
- local: `swift test`
69+
- using Docker: `swift docker-test`
5570
- Format: `make format`
5671
- Check: `make check`
5772

5873
## Contributing
5974

60-
Pull requests are welcome. Please keep changes focused and include tests for new logic.
75+
[Pull requests](https://github.com/feather-framework/feather-database/pulls) are welcome. Please keep changes focused and include tests for new logic. 🙏

0 commit comments

Comments
 (0)