Update scripts and readme

Author: danielsaidi

.github/FUNDING.yml

@@ -1,13 +1 @@
-# These are supported funding model platforms
-
 github: [danielsaidi]
-patreon: # Replace with a single Patreon username
-open_collective: # Replace with a single Open Collective username
-ko_fi: # Replace with a single Ko-fi username
-tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
-community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
-liberapay: # Replace with a single Liberapay username
-issuehunt: # Replace with a single IssueHunt username
-otechie: # Replace with a single Otechie username
-lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
-custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/workflows/build.yml

@@ -5,12 +5,9 @@ name: Build Runner
 
 on:
   push:
-    branches: ["master"]
+    branches: ["main"]
   pull_request:
-    branches: ["master"]
-    
-env:
-  SCHEME: DeckKit
+    branches: ["main"]
 
 jobs:
   build:
@@ -21,6 +18,6 @@ jobs:
         with:
           xcode-version: '16.0'
       - name: Build all platforms
-        run: bash scripts/build.sh $SCHEME
+        run: bash scripts/build.sh ${{ github.event.repository.name }}
       - name: Test iOS
-        run: bash scripts/test.sh $SCHEME
+        run: bash scripts/test.sh ${{ github.event.repository.name }}

.github/workflows/docc.yml

@@ -8,9 +8,6 @@ on:
   push:
     branches: ["master"]
 
-env:
-  SCHEME: DeckKit
-
 # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
 permissions:
   contents: read
@@ -39,18 +36,7 @@ jobs:
         with:
           xcode-version: '16.0'
       - name: Build DocC
-        run: |
-          swift package resolve;
-          
-          xcodebuild docbuild -scheme DeckKit -derivedDataPath /tmp/docbuild -destination 'generic/platform=iOS';
-          
-          $(xcrun --find docc) process-archive \
-            transform-for-static-hosting /tmp/docbuild/Build/Products/Debug-iphoneos/DeckKit.doccarchive \
-            --output-path .build/docs \
-            --hosting-base-path 'DeckKit';
-            
-          echo "<script>window.location.href += \"/documentation/deckkit\"</script>" > .build/docs/index.html;
-          
+        run: bash scripts/docc.sh ${{ github.event.repository.name }}
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:

.gitignore

@@ -9,11 +9,4 @@
 Docs
 documentation
 downloads
-videos
-
-# Fastlane
-Fastlane/report.xml
-Fastlane/Preview.html
-Fastlane/screenshots
-Fastlane/test_output
-Fastlane/README.md
+videos

README.md

@@ -4,26 +4,25 @@
 
 <p align="center">
     <img src="https://img.shields.io/github/v/release/danielsaidi/DeckKit?color=%2300550&sort=semver" alt="Version" />
-    <img src="https://img.shields.io/badge/Swift-5.9-orange.svg" alt="Swift 5.9" />
+    <img src="https://img.shields.io/badge/Swift-6.0-orange.svg" alt="Swift 6.0" />
     <img src="https://img.shields.io/badge/platform-SwiftUI-blue.svg" alt="Swift UI" title="Swift UI" />
     <img src="https://img.shields.io/github/license/danielsaidi/DeckKit" alt="MIT License" />
     <a href="https://twitter.com/danielsaidi"><img src="https://img.shields.io/twitter/url?label=Twitter&style=social&url=https%3A%2F%2Ftwitter.com%2Fdanielsaidi" alt="Twitter: @danielsaidi" title="Twitter: @danielsaidi" /></a>
     <a href="https://mastodon.social/@danielsaidi"><img src="https://img.shields.io/mastodon/follow/000253346?label=mastodon&style=social" alt="Mastodon: @[email protected]" title="Mastodon: @[email protected]" /></a>
 </p>
 
 
-
 ## About DeckKit
 
-DeckKit is a Swift SDK that helps you build deck-based apps in SwiftUI.
+DeckKit is a SwiftUI SDK that helps you build deck-based apps.
 
-DeckKit has a `DeckView` that can render any item collection, with support for swipe gestures, edge swipe detection, shuffling, etc. The result can look like this or completely different:
+DeckKit has a `DeckView` component that can render any ``DeckItem`` collection, with support for swipe gestures, edge swipes, shuffling, etc. The result can look like this, or completely different:
 
 <p align="center" style="border-radius: 10px">
     <img src="Resources/Demo.gif" width=300 alt="Demo video" />
 </p>
 
-DeckKit has other views as well, and can be customized to great extent. You can change colors, fonts, etc. and use completely custom views. It also has tools to manage favorite items.
+DeckKit can be customized to great extent. You can change colors, fonts, etc. and use completely custom views. It also has tools to manage favorites.
 
 
 
@@ -39,7 +38,7 @@ https://github.com/danielsaidi/DeckKit.git
 
 ## Getting started
 
-With DeckKit, you can create a `Deck` of any model that implement the `DeckItem` protocol:
+With DeckKit, you can create a `Deck` of any model that conform to `DeckItem`:
 
 ```swift
 struct Hobby: DeckItem {
@@ -70,19 +69,19 @@ struct MyView: View {
 }
 ```
 
-For more information, see the [getting started guide][Getting-Started].
+See the online [getting started guide][Getting-Started] for more information.
 
 
 
 ## Documentation
 
-The [online documentation][Documentation] has more information, articles, code examples, etc. 
+The online [documentation][Documentation] has more information, articles, code examples, etc.
 
 
 
 ## Demo Application
 
-The demo app lets you explore the library with iOS, macOS, and visionOS. To try it out, just open and run the `Demo` project.
+The `Demo` folder has an app that lets you test the library on iOS, macOS, and visionOS.
 
 
 

RELEASE_NOTES.md

@@ -10,6 +10,13 @@ DeckKit tries to honor semantic versioning:
 These release notes only cover the current major version. 
 
 
+
+## 1.4
+
+This version makes the SDK use Swift 6.
+
+
+
 ## 1.3
 
 This version has breaking changes for the favorite context/service setup, to make favorites easier to use.

Sources/DeckKit/DeckKit.docc/DeckKit.md

@@ -8,11 +8,11 @@ DeckKit is a SwiftUI SDK that helps you build deck-based apps.
 
 ![DeckKit logo](Logo.png)
 
-DeckKit is a Swift SDK that helps you build deck-based apps in SwiftUI.
+DeckKit is a SwiftUI SDK that helps you build deck-based apps.
 
-DeckKit has a ``DeckItem`` protocol that is automatically implemented by any type that implements `Identifiable` and `Equatable`, and extends any such ``Swift/Array`` with more functionality.
+DeckKit has a ``DeckView`` component that can render any ``DeckItem`` collection, with support for swipe gestures, edge swipes, shuffling, etc.
 
-DeckKit has a ``DeckView`` that can render an item collection as a physical deck of cards, as well as a ``DeckPageView`` that renders an item collection as a horizontally scrolling page view.
+The ``DeckItem`` type is a typealias that is automatically implemented by any type that implements `Identifiable` and `Equatable`, and extends any such ``Swift/Array`` with more functionality.
 
 DeckKit can be customized to great extent. You can change colors, fonts, corner radius etc., and use completely custom views. You can also use a ``FavoriteContext`` to manage the favorite state of any `Identifiable` type.
 

scripts/build.sh

@@ -1,22 +1,22 @@
 #!/bin/bash
 
-# Build a <TARGET> for all supported platforms.
-
-# USAGE: bash scripts/build.sh <TARGET>
+# Documentation:
+# This script builds a <TARGET> for all supported platforms.
 
 # Exit immediately if a command exits with a non-zero status
 set -e
 
-# Create local argument variables.
-TARGET=$1
-
-# Check if target is provided
+# Verify that all required arguments are provided
 if [ $# -eq 0 ]; then
-    echo "Error: No target specified"
+    echo "Error: This script requires exactly one argument"
+    echo "Usage: $0 <TARGET>"
     exit 1
 fi
 
-# Use the script folder to refer to the platform script.
+# Create local argument variables.
+TARGET=$1
+
+# Use the script folder to refer to other scripts.
 FOLDER="$( cd "$( dirname "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
 SCRIPT="$FOLDER/build_platform.sh"
 

scripts/build_platform.sh

@@ -1,8 +1,14 @@
 #!/bin/bash
 
-# Build a <TARGET> for a specific platform.
+# Documentation:
+# This script builds a <TARGET> for a specific <PLATFORM>.
 
-# USAGE: bash scripts/build_platform.sh <TARGET> <PLATFORM>
+# Verify that all required arguments are provided
+if [ $# -ne 2 ]; then
+    echo "Error: This script requires exactly two arguments"
+    echo "Usage: $0 <TARGET> <PLATFORM>"
+    exit 1
+fi
 
 TARGET=$1
 PLATFORM=$2

scripts/docc.sh

@@ -1,8 +1,15 @@
 #!/bin/bash
 
-# Build DocC documentation for a <TARGET> to .build/docs.
+# Documentation:
+# This script build DocC for a <TARGET>.
+# The documentation ends up in to .build/docs.
 
-# USAGE: bash scripts/docc.sh <TARGET>
+# Verify that all required arguments are provided
+if [ $# -eq 0 ]; then
+    echo "Error: This script requires exactly one argument"
+    echo "Usage: $0 <TARGET>"
+    exit 1
+fi
 
 TARGET=$1
 TARGET_LOWERCASED=$(echo "$1" | tr '[:upper:]' '[:lower:]')
@@ -14,6 +21,6 @@ xcodebuild docbuild -scheme $1 -derivedDataPath /tmp/docbuild -destination 'gene
 $(xcrun --find docc) process-archive \
   transform-for-static-hosting /tmp/docbuild/Build/Products/Debug-iphoneos/$1.doccarchive \
   --output-path .build/docs \
-  --hosting-base-path '$1';
+  --hosting-base-path "$TARGET";
 
 echo "<script>window.location.href += \"/documentation/$TARGET_LOWERCASED\"</script>" > .build/docs/index.html;

scripts/test.sh

@@ -1,40 +1,40 @@
 #!/bin/bash
 
-# Test a <TARGET> for all supported platforms.
-
-# USAGE: bash scripts/test.sh <TARGET>
+# Documentation:
+# This script tests a <TARGET> for all supported platforms.
 
 # Exit immediately if a command exits with a non-zero status
 set -e
 
-# Create local argument variables.
-TARGET=$1
-
-# Check if target is provided
+# Verify that all required arguments are provided
 if [ $# -eq 0 ]; then
-    echo "Error: No target specified"
+    echo "Error: This script requires exactly one argument"
+    echo "Usage: $0 <TARGET>"
     exit 1
 fi
 
-# Use the script folder to refer to the platform script.
+# Create local argument variables.
+TARGET=$1
+
+# Use the script folder to refer to other scripts.
 FOLDER="$( cd "$( dirname "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
 SCRIPT="$FOLDER/test_platform.sh"
 
 # Make the script executable
 chmod +x $SCRIPT
 
-# A function that builds a specific platform
+# A function that tests a specific platform
 test_platform() {
     local platform=$1
-    echo "Building for $platform..."
+    echo "Testing for $platform..."
     if ! bash $SCRIPT $TARGET $platform; then
-        echo "Failed to build $platform"
+        echo "Failed to test $platform"
         return 1
     fi
-    echo "Successfully built $platform"
+    echo "Successfully tested $platform"
 }
 
-# Array of platforms to build
+# Array of platforms to test
 platforms=("platform=iOS_Simulator,name=iPhone_16")
 
 # Loop through platforms and build

scripts/test_platform.sh

@@ -1,10 +1,15 @@
 #!/bin/bash
 
-# Test the SDK for a specific platform.
-
+# Documentation:
+# This script tests a <TARGET> for a specific platform.
 # Use _ instead of spaces when passing in the <PLATFORM>.
 
-# USAGE: bash scripts/build_platform.sh <TARGET> <PLATFORM>
+# Verify that all required arguments are provided
+if [ $# -ne 2 ]; then
+    echo "Error: This script requires exactly two arguments"
+    echo "Usage: $0 <TARGET> <PLATFORM>"
+    exit 1
+fi
 
 TARGET=$1
 PLATFORM="${2//_/ }"