From 24d06011684756eb252628bac71e13f4cbab087a Mon Sep 17 00:00:00 2001 From: MiscFrizzy Date: Mon, 7 Apr 2025 06:38:22 -0400 Subject: [PATCH] feat(docs): Add badges for version, dependencies, and license to README.md - Added a version badge to indicate the current version of the project. - Included a dependencies badge to show the status of project dependencies. - Added a license badge to clarify the licensing of the project. chore(ci): Update test workflow to improve coverage reporting - Updated the test.yml workflow to include coverage reporting using Codecov. - Ensured that the workflow runs on pushes and pull requests to main and develop branches. --- .github/workflows/test.yml | 13 +------------ README.md | 5 ++++- 2 files changed, 5 insertions(+), 13 deletions(-) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index d5597e1..77de82f 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -32,15 +32,4 @@ jobs: uses: codecov/codecov-action@v3 with: file: ./lcov.info - fail_ci_if_error: false - - - name: Create status badge - if: github.ref == 'refs/heads/main' && github.event_name == 'push' - uses: schneegans/dynamic-badges-action@v1.6.0 - with: - auth: ${{ secrets.GIST_SECRET }} - gistID: ${{ secrets.GIST_ID }} - filename: vrcauthproxy-tests.json - label: tests - message: passing - color: success \ No newline at end of file + fail_ci_if_error: false \ No newline at end of file diff --git a/README.md b/README.md index 2cde77d..9dc147d 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,10 @@ #### A VRChat API Authorization Proxy Service [![Build](https://github.com/PrideVRInc/VRCAuthProxy/actions/workflows/build.yml/badge.svg)](https://github.com/PrideVRInc/VRCAuthProxy/actions/workflows/build.yml) -[![Tests](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/USER_PLACEHOLDER/GIST_ID_PLACEHOLDER/raw/vrcauthproxy-tests.json)](https://github.com/PrideVRInc/VRCAuthProxy/actions/workflows/test.yml) +[![Tests](https://github.com/PrideVRInc/VRCAuthProxy/actions/workflows/test.yml/badge.svg)](https://github.com/PrideVRInc/VRCAuthProxy/actions/workflows/test.yml) +[![Version](https://img.shields.io/badge/version-1.0.0-blue.svg)](https://github.com/PrideVRInc/VRCAuthProxy/releases) +[![Dependencies](https://img.shields.io/david/PrideVRInc/VRCAuthProxy.svg)](https://david-dm.org/PrideVRInc/VRCAuthProxy) +[![License](https://img.shields.io/badge/license-MPL--2.0-brightgreen.svg)](https://opensource.org/licenses/MPL-2.0) This authorization proxy service is for consuming the VRChat API in a multi-application / microservice architecture. Configure the proxy with the credentials for accounts you use to make API calls and direct your API clients to the proxy service instead of the VRChat API. The proxy server will handle the authorization call flow and caching of the authorization tokens for subsequent authorized calls.