Merge pull request #7 from maxxfrazer/add-docs

Docs Deploy

Author: maxxfrazer

.github/workflows/build-docc.yml

@@ -0,0 +1,29 @@
+name: Deploy DocC
+
+on:
+  push:
+    tags:
+      - '*'
+
+permissions:
+  contents: write
+jobs:
+  build_docs:
+    runs-on: macos-12
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/checkout@v3
+
+      - name: Build DocC
+        run: |
+          swift package resolve;
+          xcodebuild docbuild -scheme RealityUI -derivedDataPath /tmp/docbuild -destination 'generic/platform=iOS';
+          $(xcrun --find docc) process-archive \
+            transform-for-static-hosting /tmp/docbuild/Build/Products/Debug-iphoneos/RealityUI.doccarchive \
+            --hosting-base-path RealityUI \
+            --output-path docs;
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs

.github/workflows/swift-build.yml

@@ -4,6 +4,8 @@ on:
   push:
     branches:
       - "main"
+    tags:
+      - '*'
   pull_request:
     branches:
     - "*"
@@ -12,7 +14,9 @@ jobs:
   build:
     runs-on: macOS-latest
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v3
+    - name: Swift Lint
+      run: swiftlint --strict
     - name: Build Package
       run: |
         swift package generate-xcodeproj

.github/workflows/swift-lint.yml

@@ -0,0 +1,5 @@
+version: 1
+builder:
+  configs:
+    - platform: ios
+      documentation_targets: [RealityUI]

.spi.yml

@@ -32,7 +32,7 @@ The User Interface controls in this repository so far are made to be familiar to
 - [Text](#text)
 - [More](#more)
   - [RealityUI Wiki](https://github.com/maxxfrazer/RealityUI/wiki)
-  - [Documentation](https://maxxfrazer.github.io/RealityUI/)
+  - [Documentation](https://maxxfrazer.github.io/RealityUI/documentation/realityui/)
   - [Example Project](https://github.com/maxxfrazer/RealityUI/tree/main/RealityUI%2BExamples)
 
 ## Installation
@@ -117,7 +117,7 @@ Unlock the ability to rotate a RealityKit entity with just one finger.
 
 Create an object in your RealityKit scene with an action, and it will automatically be picked up whenever the user taps on it!
 
-No Gif for this one, but check out [RealityUI Gestures wiki](https://github.com/maxxfrazer/RealityUI/wiki/Gestures#tap) to see how to add [HasClick](https://maxxfrazer.github.io/RealityUI/Protocols/HasClick.html) to an entity in your application.
+No Gif for this one, but check out [RealityUI Gestures wiki](https://github.com/maxxfrazer/RealityUI/wiki/Gestures#tap) to see how to add [HasClick](https://maxxfrazer.github.io/RealityUI/documentation/realityui/HasClick.html) to an entity in your application.
 
 ---
 ## Animations
@@ -152,6 +152,6 @@ With RUIText you can easily create an Entity with the specified text placed with
 ---
 ## More
 
-More information on everything provided in this Swift Package in the [GitHub Wiki](https://github.com/maxxfrazer/RealityUI/wiki), and also the [documentation](https://maxxfrazer.github.io/RealityUI/).
+More information on everything provided in this Swift Package in the [GitHub Wiki](https://github.com/maxxfrazer/RealityUI/wiki), and also the [documentation](https://maxxfrazer.github.io/RealityUI/documentation/realityui/).
 
 Also see the [Example Project](https://github.com/maxxfrazer/RealityUI/tree/main/RealityUI%2BExamples) for iOS in this repository.

README.md

@@ -44,7 +44,11 @@ public class RUIButton: Entity, HasButton, HasModel, HasPhysics {
 
   public func arTouchUpdated(_ worldCoordinate: SIMD3<Float>, hasCollided: Bool) {
     if hasCollided != self.isCompressed {
-      hasCollided ? self.compressButton() : self.releaseButton()
+      if hasCollided {
+        self.compressButton()
+      } else {
+        self.releaseButton()
+      }
     }
   }