Skip to content

Commit

Permalink
Fixing Documentation (#49)
Browse files Browse the repository at this point in the history
* Specifying Swift Version in SPI Configuration
* Update Table of Contents
* Fixing Header Script
  • Loading branch information
leogdion authored Sep 17, 2024
1 parent 5a76852 commit 41c76aa
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 6 deletions.
1 change: 1 addition & 0 deletions .spi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ version: 1
builder:
configs:
- documentation_targets: [Sublimation]
swift_version: 6.0
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

<!-- Created by https://github.com/ekalinin/github-markdown-toc -->

# 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.
Expand Down Expand Up @@ -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 |
| ---------- | ----------- |
Expand Down Expand Up @@ -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:

Expand Down Expand Up @@ -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).

Expand Down
4 changes: 2 additions & 2 deletions Scripts/lint.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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
popd

0 comments on commit 41c76aa

Please sign in to comment.