Skip to content

Commit

Permalink
Use improved logos for README and API docs (#53)
Browse files Browse the repository at this point in the history
Use improved logos for readme and docs
  • Loading branch information
gwynne authored Aug 16, 2023
1 parent 2fbea45 commit cf35812
Show file tree
Hide file tree
Showing 8 changed files with 118 additions and 32 deletions.
3 changes: 1 addition & 2 deletions .github/workflows/api-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,4 @@ jobs:
with:
package_name: sqlite-nio
modules: SQLiteNIO
pathsToInvalidate: /sqlitenio

pathsToInvalidate: /sqlitenio/*
2 changes: 1 addition & 1 deletion .github/workflows/projectboard.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ on:
jobs:
update_project_boards:
name: Update project boards
uses: vapor/ci/.github/workflows/update-project-boards-for-issue.yml@reusable-workflows
uses: vapor/ci/.github/workflows/update-project-boards-for-issue.yml@main
secrets: inherit
38 changes: 12 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,17 @@
<p align="center">
<img
src="https://user-images.githubusercontent.com/1342803/58997662-a5209e80-87cb-11e9-859d-e04ec148fd05.png"
height="64"
alt="SQLiteNIO"
>
<br>
<br>
<a href="https://docs.vapor.codes/4.0/">
<img src="http://img.shields.io/badge/read_the-docs-2196f3.svg" alt="Documentation">
</a>
<a href="https://discord.gg/vapor">
<img src="https://img.shields.io/discord/431917998102675485.svg" alt="Team Chat">
</a>
<a href="LICENSE">
<img src="http://img.shields.io/badge/license-MIT-brightgreen.svg" alt="MIT License">
</a>
<a href="https://github.com/vapor/sqlite-nio/actions/workflows/test.yml">
<img src="https://github.com/vapor/sqlite-nio/actions/workflows/test.yml/badge.svg?action=push" alt="Continuous Integration">
</a>
<a href="https://swift.org">
<img src="http://img.shields.io/badge/swift-5.6-brightgreen.svg" alt="Swift 5.6">
</a>
<a href="https://swift.org">
<img src="http://img.shields.io/badge/swift-5.8-brightgreen.svg" alt="Swift 5.8">
</a>
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/1130717/260921486-00ad7131-9bcf-4967-b7de-24a144944166.png">
<source media="(prefers-color-scheme: light)" srcset="https://user-images.githubusercontent.com/1130717/260921565-f8bb2ea8-856d-48d6-a696-134e5c71733d.png">
<img src="https://user-images.githubusercontent.com/1130717/260921565-f8bb2ea8-856d-48d6-a696-134e5c71733d.png" height="96" alt="SQLiteNIO">
</picture>
<br>
<br>
<a name=""><img src="https://img.shields.io/badge/sswg-incubating-green.svg" alt="SSWG Incubation"></a>
<a href="https://api.vapor.codes/sqlitenio/documentation/sqlitenio/"><img src="https://img.shields.io/badge/read_the-docs-2196f3.svg" alt="Documentation"></a>
<a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-brightgreen.svg" alt="MIT License"></a>
<a href="https://github.com/vapor/sqlite-nio/actions/workflows/test.yml"><img src="https://github.com/vapor/sqlite-nio/actions/workflows/test.yml/badge.svg" alt="Continuous Integration"></a>
<a href="https://swift.org"><img src="https://img.shields.io/badge/swift-5.6-brightgreen.svg" alt="Swift 5.6"></a>
</p>

<br>

🐬 Non-blocking, event-driven Swift client for [SQLite](https://sqlite.org) built on [SwiftNIO](https://github.com/apple/swift-nio).
Expand Down
17 changes: 17 additions & 0 deletions Sources/SQLiteNIO/Docs.docc/Documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# ``SQLiteNIO``

@Metadata {
@TitleHeading(Package)
}

🪶 Non-blocking, event-driven Swift client for SQLite with embedded libsqlite

## Supported Versions

This package is compatible with all platforms supported by [SwiftNIO 2.x](https://github.com/apple/swift-nio/). It has
been specifically tested on the following platforms:

- Ubuntu 20.04 ("Focal") and 22.04 ("Jammy")
- Amazon Linux 2
- macOS 10.15 and later
- iOS 13 and later
1 change: 1 addition & 0 deletions Sources/SQLiteNIO/Docs.docc/images/article.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
40 changes: 40 additions & 0 deletions Sources/SQLiteNIO/Docs.docc/images/vapor-sqlite-logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 0 additions & 3 deletions Sources/SQLiteNIO/Docs.docc/index.md

This file was deleted.

46 changes: 46 additions & 0 deletions Sources/SQLiteNIO/Docs.docc/theme-settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
{
"theme": {
"aside": {
"border-radius": "6px",
"border-style": "double",
"border-width": "3px"
},
"border-radius": "0",
"button": {
"border-radius": "16px",
"border-width": "1px",
"border-style": "solid"
},
"code": {
"border-radius": "16px",
"border-width": "1px",
"border-style": "solid"
},
"color": {
"fill": {
"dark": "rgb(20, 20, 22)",
"light": "rgb(255, 255, 255)"
},
"sqlite-teal": "hsl(215, 45%, 58%)",
"documentation-intro-fill": "radial-gradient(circle at top, var(--color-documentation-intro-accent) 30%, #1f1d1f 100%)",
"documentation-intro-accent": "var(--color-sqlite-teal)",
"documentation-intro-accent-outer": {
"dark": "rgb(255, 255, 255)",
"light": "rgb(51, 51, 51)"
},
"documentation-intro-accent-inner": {
"dark": "rgb(51, 51, 51)",
"light": "rgb(255, 255, 255)"
}
},
"icons": {
"technology": "/sqlitenio/images/vapor-sqlite-logo.svg",
"article": "/sqlitenio/images/article.svg"
}
},
"features": {
"quickNavigation": {
"enable": true
}
}
}

0 comments on commit cf35812

Please sign in to comment.