Merge branch 'develop' of git.gay:pupsie/vrcauthproxy into develop

LICENSE.md

@@ -83,4 +83,4 @@ You may add additional accurate notices of copyright ownership.
 
 # Addendum to MPL 2.0 License Aggrement
 **1.** Follow VRChat [Terms of Service](https://hello.vrchat.com/legal) and [Creator Guidelines](https://hello.vrchat.com/creator-guidelines#:~:text=or%20suggestive%20content.-,API%20Usage%20/%20Bots) when using this software with the VRChat API.
-**2.** You are resonsible for any use of this software that results in VRChat Trust & Safety actioning you. You release PrideVR, INC, and any of their volunteers, of any and all liability.
+**2.** You are resonsible for any use of this software that results in VRChat Trust & Safety actioning you. You release Pupsie Co., and any of their staff, of any and all liability.

README.md

@@ -136,6 +136,4 @@ MPL-2.0 with Addendum
 Contributors list made with [contrib.rocks](https://contrib.rocks).
 
 
-© 2025 [PrideVR, INC](https://pridevr.org)
-
-A VR Pride Organization
+© 2025 [Pupsie, CO](https://pupsie.co)

docs/BADGE_SETUP.md

@@ -0,0 +1,45 @@
+# Setting Up GitHub Badges
+
+This document explains how to set up the GitHub Secrets required for the test status badge functionality.
+
+## Steps to Create a GitHub Gist for Badge Storage
+
+1. Create a new public GitHub Gist at https://gist.github.com/
+   - Add a file named `vrcauthproxy-tests.json` with the following content:
+   ```json
+   {
+     "schemaVersion": 1,
+     "label": "tests",
+     "message": "unknown",
+     "color": "lightgrey"
+   }
+   ```
+   - Save the Gist
+
+2. Note the Gist ID from the URL
+   - The URL will look like: `https://gist.github.com/YOUR_USERNAME/GIST_ID`
+   - Copy the `GIST_ID` part
+
+## Creating GitHub Secrets
+
+1. In your VRCAuthProxy repository, go to **Settings** > **Secrets and variables** > **Actions**
+2. Create the following secrets:
+
+   - **GIST_ID**
+     - Value: The Gist ID you copied in step 2 above
+   
+   - **GIST_SECRET**
+     - Value: A GitHub Personal Access Token (PAT) with `gist` scope
+     - To create a PAT, go to your GitHub account **Settings** > **Developer settings** > **Personal access tokens** > **Tokens (classic)**
+     - Generate a new token with at least the `gist` scope
+     - Copy the token value (you won't be able to see it again after leaving the page)
+
+3. Update the README.md badge URL
+   - Replace `USER_PLACEHOLDER` with your GitHub username
+   - Replace `GIST_ID_PLACEHOLDER` with your Gist ID
+
+## Testing the Setup
+
+After setting up the secrets and updating the README.md, push a commit to the main branch to trigger the workflow that will update the badge status.
+
+If everything is set up correctly, the badge in the README should display the current test status (passing or failing). 

docs/WORKFLOWS_GUIDE.md

@@ -0,0 +1,64 @@
+# GitHub Actions Workflows Guide
+
+This document explains the GitHub Actions workflows set up for this project.
+
+## Available Workflows
+
+### 1. Run Tests Workflow (`test.yml`)
+
+This workflow runs on pushes to `main` and `develop` branches, as well as on pull requests to these branches. It:
+
+- Builds the project
+- Runs all tests
+- Generates code coverage reports
+- Uploads coverage to Codecov
+- Updates the test status badge (on push to main)
+
+### 2. Update Badges Workflow (`update-badges.yml`)
+
+This workflow runs whenever the "Run Tests" workflow completes. It:
+
+- Updates the test status badge based on the test results (passing/failing)
+
+### 3. PR Tests Workflow (`pr-test.yml`)
+
+This workflow runs on pull requests to `main` and `develop` branches. It:
+
+- Builds the project
+- Runs all tests
+- Generates test results and code coverage reports
+- Comments on the PR with test results
+- Uploads coverage reports to Codecov
+
+### 4. Build Docker Image Workflow (existing `build.yml`)
+
+This workflow runs on pushes to the `main` branch. It:
+
+- Builds the Docker image
+- Pushes the image to the GitHub Container Registry
+
+## Setting Up Badge Functionality
+
+To enable the badge functionality, follow the instructions in [BADGE_SETUP.md](BADGE_SETUP.md).
+
+## GitHub Secrets
+
+The following GitHub Secrets are required:
+
+- `GIST_SECRET`: A GitHub Personal Access Token with `gist` scope
+- `GIST_ID`: The ID of the GitHub Gist used to store badge data
+
+## Badge in README
+
+The README includes two badges:
+1. Build Status: Shows the status of the most recent build workflow
+2. Tests Status: Shows whether the tests are passing or failing
+
+## Workflow Customization
+
+You can customize these workflows by editing the YAML files in the `.github/workflows` directory:
+
+- `.github/workflows/test.yml`
+- `.github/workflows/update-badges.yml`
+- `.github/workflows/pr-test.yml`
+- `.github/workflows/build.yml`