From cf35812930331d9cd80797471218e988479e46b8 Mon Sep 17 00:00:00 2001 From: Gwynne Raskind Date: Wed, 16 Aug 2023 03:04:26 -0500 Subject: [PATCH] Use improved logos for README and API docs (#53) Use improved logos for readme and docs --- .github/workflows/api-docs.yml | 3 +- .github/workflows/projectboard.yml | 2 +- README.md | 38 +++++---------- Sources/SQLiteNIO/Docs.docc/Documentation.md | 17 +++++++ .../SQLiteNIO/Docs.docc/images/article.svg | 1 + .../Docs.docc/images/vapor-sqlite-logo.svg | 40 ++++++++++++++++ Sources/SQLiteNIO/Docs.docc/index.md | 3 -- .../SQLiteNIO/Docs.docc/theme-settings.json | 46 +++++++++++++++++++ 8 files changed, 118 insertions(+), 32 deletions(-) create mode 100644 Sources/SQLiteNIO/Docs.docc/Documentation.md create mode 100644 Sources/SQLiteNIO/Docs.docc/images/article.svg create mode 100644 Sources/SQLiteNIO/Docs.docc/images/vapor-sqlite-logo.svg delete mode 100644 Sources/SQLiteNIO/Docs.docc/index.md create mode 100644 Sources/SQLiteNIO/Docs.docc/theme-settings.json diff --git a/.github/workflows/api-docs.yml b/.github/workflows/api-docs.yml index f9e8904..d1525fd 100644 --- a/.github/workflows/api-docs.yml +++ b/.github/workflows/api-docs.yml @@ -11,5 +11,4 @@ jobs: with: package_name: sqlite-nio modules: SQLiteNIO - pathsToInvalidate: /sqlitenio - + pathsToInvalidate: /sqlitenio/* diff --git a/.github/workflows/projectboard.yml b/.github/workflows/projectboard.yml index a0e6d98..8c8f4bd 100644 --- a/.github/workflows/projectboard.yml +++ b/.github/workflows/projectboard.yml @@ -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 diff --git a/README.md b/README.md index aa41f25..7b43bbb 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,17 @@

- SQLiteNIO -
-
- - Documentation - - - Team Chat - - - MIT License - - - Continuous Integration - - - Swift 5.6 - - - Swift 5.8 - + + + + SQLiteNIO + +
+
+SSWG Incubation +Documentation +MIT License +Continuous Integration +Swift 5.6

-
🐬 Non-blocking, event-driven Swift client for [SQLite](https://sqlite.org) built on [SwiftNIO](https://github.com/apple/swift-nio). diff --git a/Sources/SQLiteNIO/Docs.docc/Documentation.md b/Sources/SQLiteNIO/Docs.docc/Documentation.md new file mode 100644 index 0000000..4ef954f --- /dev/null +++ b/Sources/SQLiteNIO/Docs.docc/Documentation.md @@ -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 diff --git a/Sources/SQLiteNIO/Docs.docc/images/article.svg b/Sources/SQLiteNIO/Docs.docc/images/article.svg new file mode 100644 index 0000000..3dc6a66 --- /dev/null +++ b/Sources/SQLiteNIO/Docs.docc/images/article.svg @@ -0,0 +1 @@ + diff --git a/Sources/SQLiteNIO/Docs.docc/images/vapor-sqlite-logo.svg b/Sources/SQLiteNIO/Docs.docc/images/vapor-sqlite-logo.svg new file mode 100644 index 0000000..ae1d689 --- /dev/null +++ b/Sources/SQLiteNIO/Docs.docc/images/vapor-sqlite-logo.svg @@ -0,0 +1,40 @@ + + + + + + + + + + + + + + + + + + + diff --git a/Sources/SQLiteNIO/Docs.docc/index.md b/Sources/SQLiteNIO/Docs.docc/index.md deleted file mode 100644 index ad080df..0000000 --- a/Sources/SQLiteNIO/Docs.docc/index.md +++ /dev/null @@ -1,3 +0,0 @@ -# ``SQLiteNIO`` - -SQLiteNIO is a driver for the SQLite database written in Swift. It uses SwiftNIO under the hood to provide a non-blocking API. \ No newline at end of file diff --git a/Sources/SQLiteNIO/Docs.docc/theme-settings.json b/Sources/SQLiteNIO/Docs.docc/theme-settings.json new file mode 100644 index 0000000..ccd39c0 --- /dev/null +++ b/Sources/SQLiteNIO/Docs.docc/theme-settings.json @@ -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 + } + } +}