From 41c76aa39b66b3159945352cecd41994b309a6ca Mon Sep 17 00:00:00 2001 From: leogdion Date: Tue, 17 Sep 2024 08:49:32 -0400 Subject: [PATCH] Fixing Documentation (#49) * Specifying Swift Version in SPI Configuration * Update Table of Contents * Fixing Header Script --- .spi.yml | 1 + README.md | 13 +++++++++---- Scripts/lint.sh | 4 ++-- 3 files changed, 12 insertions(+), 6 deletions(-) diff --git a/.spi.yml b/.spi.yml index de9cfd2..7edb708 100644 --- a/.spi.yml +++ b/.spi.yml @@ -2,3 +2,4 @@ version: 1 builder: configs: - documentation_targets: [Sublimation] + swift_version: 6.0 diff --git a/README.md b/README.md index b92c426..34eae0c 100644 --- a/README.md +++ b/README.md @@ -27,9 +27,14 @@ Turn your Server-Side Swift app from a _mysterious vapor_ to a **tangible solid # Table of Contents * [Introduction](#introduction) - * [Requirements](#requirements) + * [Requirements](#requirements) +* [Package Ecosystem](#package-ecosystem) +* [Usage](#usage) +* [Documentation](#documentation) * [License](#license) + + # Introduction When you are developing a Full Stack Swift application, you want to easily test and debug your application on both the device (iPhone, Apple Watch, iPad, etc...) as well as your development server. If you are using simulator then setting your host server to `localhost` this may work but often you need to test on an actual device. @@ -72,7 +77,7 @@ flowchart TD For **older operating systems or Swift versions**, check out [the main branch and 1.0.0 releases](https://github.com/brightdigit/Sublimation). -## Package Ecosystem +# Package Ecosystem | Repository | Description | | ---------- | ----------- | @@ -101,7 +106,7 @@ To use **Sublimation**, you'll need to choose: * [Lifecycle Handler for Vapor](https://docs.vapor.codes/advanced/services/#lifecycle) via [SublimationVapor](https://github.com/brightdigit/SublimationBonjour) * [Lifecycle Service](https://github.com/swift-server/swift-service-lifecycle) via [SublimationService](https://github.com/brightdigit/SublimationBonjour) _for server frameworks such as [Hummingbird](https://docs.hummingbird.codes/2.0/documentation/hummingbird/)_ -## Usage +# Usage For instance if you were using **Bonjour** with **Hummingbird** and an iOS app your package may look something like this: @@ -171,7 +176,7 @@ let package = Package( Please check the respective package documentation from the [Package Ecosystem](#package-ecosystem) section. -## Documentation +# Documentation To learn more, check out the full [documentation](https://swiftpackageindex.com/brightdigit/Sublimation/2.0.0-beta.1/documentation/sublimation). diff --git a/Scripts/lint.sh b/Scripts/lint.sh index a6a8b8b..cdd265e 100755 --- a/Scripts/lint.sh +++ b/Scripts/lint.sh @@ -42,9 +42,9 @@ else set -e fi -$PACKAGE_DIR/scripts/header.sh -d $PACKAGE_DIR/Sources -c "Leo Dion" -o "BrightDigit" -p "SublimationBonjour" +$PACKAGE_DIR/scripts/header.sh -d $PACKAGE_DIR/Sources -c "Leo Dion" -o "BrightDigit" -p "Sublimation" $MINT_RUN swift-format lint --recursive --parallel $SWIFTFORMAT_OPTIONS $PACKAGE_DIR/Sources pushd $PACKAGE_DIR $MINT_RUN periphery scan $PERIPHERY_OPTIONS --disable-update-check -popd \ No newline at end of file +popd