Merge branch 'dependabot-april' into dependabot/go_modules/golang.org/x/net-0.23.0

Author: holysoles

.github/workflows/ci.yaml

@@ -0,0 +1,50 @@
+name: Build and Release
+
+on: push
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: "1.21"
+      - name: Install Depends
+        run: go get .
+      - name: Build amd64
+        run: GOOS=darwin GOARCH=amd64 go build -v -o ./facetime_macos_amd64
+      - name: Build arm64
+        run: GOOS=darwin GOARCH=arm64 go build -v -o ./facetime_macos_arm64
+      - name: Upload Build Artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: facetime-builds
+          path: |
+            ./facetime_macos_amd64
+            ./facetime_macos_arm64
+  release:
+    needs: build
+    if: github.ref == 'refs/heads/master'
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Download Artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: facetime-builds
+      - name: Generate Tag
+        id: tag_version
+        uses: mathieudutour/github-tag-action@v6.2
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Generate Release
+        uses: softprops/action-gh-release@v2
+        with:
+          name: Release ${{ steps.tag_version.outputs.new_tag }}
+          tag_name: ${{ steps.tag_version.outputs.new_tag }}
+          files: |
+            ./facetime_macos_amd64
+            ./facetime_macos_arm64

README.MD

@@ -1,5 +1,27 @@
 # holysoles-facetime
-A Go webserver that wraps the FaceTime application on MacOS for interoperability using AppleScript.
+
+A Go webserver that wraps the FaceTime application on macOS for interoperability using AppleScript.
+
+## Overview
+
+In macOS 12, Apple [introduced the ability](https://support.apple.com/guide/facetime/join-a-call-from-a-facetime-link-fctm2cd42547/5.0/mac/13.0) to create a link to a FaceTime call, that both others who have Apple devices can join in the native FaceTime apps, or other users via Chromium web browsers. Since this functionality also works on mobile, those who own a Mac but not an iPhone aren't able to initiate FaceTime calls to friends and family.
+
+This runs on a Mac to wrap the native FaceTime application and its interaction with FaceTime links, using AppleScript and its ability to interact with applications.
+
+## Setup
+
+- Support has only been verified on macOS Ventura (13.6+) but may work on others.
+- After downloading, ensure you set execute permissions on the executable: `chmod  u=rwx ./facetime_macos_arm64`
+- the environment variable `TRUSTED_PROXIES` should be set with the IP addresses/ranges that should be treated as proxy sources for Gin.
+
+### Registering Daemon
+
+A plist file for configuring a launchd daemon for running the web server is provided in the `/lib` folder of this repo. It can be loaded and unloaded with:
+
+```bash
+launchctl load -w ~/Library/LaunchAgents/localhost.facetime-service.plist
+launchctl unload -w ~/Library/LaunchAgents/localhost.facetime-service.plist
+```
 
 ## API Call Examples
 
@@ -33,6 +55,9 @@ curl --location --request DELETE 'http://localhost:8080/link' \
 --data '{"link":"https://facetime.apple.com/join#v=1\u0026p=1bv0//lFFe6uYY7be8h5vw\u0026k=fkA7tz4FRASGFLc5345_pkFJ_rCQJAdJH6F8z2OGrIZ"}'
 ```
 
+## Contributing
+- Commits should follow [Angular Commit Guidelines](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines) for the Github Tag workflow's parsing.
+
 ## Credits
 Special thanks to the following projects for providing essential resources:
 - [gin-gonic/gin](https://github.com/gin-gonic/gin)