Skip to content

Commit 6c12c0c

Browse files
tibGErP83
andauthored
Fix version in readme (#17)
Fixed version string in README.md --------- Co-authored-by: GErP83 <gurrka@gmail.com>
1 parent 4ef69e6 commit 6c12c0c

4 files changed

Lines changed: 25 additions & 31 deletions

File tree

.github/workflows/deployment.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ on:
55
tags:
66
- 'v*'
77
- '[0-9]*'
8+
workflow_dispatch:
89

910
jobs:
1011

.github/workflows/testing.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ jobs:
1515
format_check_enabled : true
1616
broken_symlink_check_enabled : true
1717
unacceptable_language_check_enabled : true
18-
shell_check_enabled : true
18+
shell_check_enabled : false
1919
docs_check_enabled : false
2020
api_breakage_check_enabled : false
2121
license_header_check_enabled : false
@@ -27,7 +27,7 @@ jobs:
2727
uses: BinaryBirds/github-workflows/.github/workflows/extra_soundness.yml@main
2828
with:
2929
local_swift_dependencies_check_enabled : true
30-
headers_check_enabled : true
30+
headers_check_enabled : false
3131
docc_warnings_check_enabled : true
3232

3333
swiftlang_tests:

Makefile

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@ SHELL=/bin/bash
22

33
baseUrl = https://raw.githubusercontent.com/BinaryBirds/github-workflows/refs/heads/main/scripts
44

5-
check: symlinks language deps lint headers
5+
check: symlinks language deps lint headers docc-warnings package
6+
7+
package:
8+
curl -s $(baseUrl)/check-swift-package.sh | bash
69

710
symlinks:
811
curl -s $(baseUrl)/check-broken-symlinks.sh | bash

README.md

Lines changed: 18 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -2,33 +2,29 @@
22

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

5-
[
6-
![Release: 1.0.0-beta.3](https://img.shields.io/badge/Release-1%2E0%2E0--beta%3E2-F05138)
7-
](
8-
https://github.com/feather-framework/feather-database/releases/tag/1.0.0-beta.3
9-
)
5+
[![Release: 1.0.0-beta.3](https://img.shields.io/badge/Release-1%2E0%2E0--beta%2E3-F05138)](https://github.com/feather-framework/feather-database/releases/tag/1.0.0-beta.3)
106

117
## Features
128

13-
- 🤝 Database-agnostic abstraction layer
14-
- 🔀 Designed for modern Swift concurrency
15-
- 📚 DocC-based API Documentation
16-
- Unit tests and code coverage
9+
- Database-agnostic abstraction layer
10+
- Designed for modern Swift concurrency
11+
- DocC-based API Documentation
12+
- Unit tests and code coverage
1713

1814
## Requirements
1915

2016
![Swift 6.1+](https://img.shields.io/badge/Swift-6%2E1%2B-F05138)
2117
![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)
22-
18+
2319
- Swift 6.1+
2420

25-
- Platforms:
26-
- Linux
27-
- macOS 15+
28-
- iOS 18+
29-
- tvOS 18+
30-
- watchOS 11+
31-
- visionOS 2+
21+
- Platforms:
22+
- Linux
23+
- macOS 15+
24+
- iOS 18+
25+
- tvOS 18+
26+
- watchOS 11+
27+
- visionOS 2+
3228

3329
## Installation
3430

@@ -46,19 +42,13 @@ Then add `FeatherDatabase` to your target dependencies:
4642

4743
## Usage
4844

49-
[
50-
![DocC API documentation](https://img.shields.io/badge/DocC-API_documentation-F05138)
51-
](
52-
https://feather-framework.github.io/feather-database/documentation/featherdatabase/
53-
)
54-
45+
[![DocC API documentation](https://img.shields.io/badge/DocC-API_documentation-F05138)](https://feather-framework.github.io/feather-database/)
5546

5647
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.
5748

5849
> [!WARNING]
5950
> This repository is a work in progress, things can break until it reaches v1.0.0.
6051
61-
6252
## Database drivers
6353

6454
The following database driver implementations are available for use:
@@ -70,12 +60,12 @@ The following database driver implementations are available for use:
7060
## Development
7161

7262
- Build: `swift build`
73-
- Test:
74-
- local: `swift test`
75-
- using Docker: `make docker-test`
63+
- Test:
64+
- local: `swift test`
65+
- using Docker: `make docker-test`
7666
- Format: `make format`
7767
- Check: `make check`
7868

7969
## Contributing
8070

81-
[Pull requests](https://github.com/feather-framework/feather-database/pulls) are welcome. Please keep changes focused and include tests for new logic. 🙏
71+
[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)