TAU- Twitch API Unifier, a containerized relay/proxy to unify the WebHook- and WebSocket-based real-time Twitch APIs under a single (local) WebSocket connection.
Create initial documentation for API endpoints, as well as updates the .gitignore to ignore the .idea directory for us jetbrains users.
Related to #60
Related to #8
Description
Endpoints documented:
[X] /api/v1/twitch-events
[x] /api/v1/heartbeat
[x] /api/v1/streamers
[x] /api/v1/twitch/scopes
[x] /api/v1/twitch/helix-endpoints
Create CI job to build the docs using mkdocs in the read the docs theme in prep for deploying them, see https://github.com/wwsean08/tau/actions/runs/975634598 as an example with the mkdocs artifact that you can open to view the docs live in your browser.
Motivation and Context
Make usage of tau easier for new users by documenting the various API endpoints.
How Has This Been Tested?
N/A
Types of changes
[X] Documentation
Checklist:
[X] My change requires a change to the documentation.
Create initial documentation for API endpoints, as well as updates the .gitignore to ignore the .idea directory for us jetbrains users.
Related to #60 Related to #8
Description
Endpoints documented:
/api/v1/twitch-events
/api/v1/heartbeat
/api/v1/streamers
/api/v1/twitch/scopes
/api/v1/twitch/helix-endpoints
Create CI job to build the docs using mkdocs in the read the docs theme in prep for deploying them, see https://github.com/wwsean08/tau/actions/runs/975634598 as an example with the mkdocs artifact that you can open to view the docs live in your browser.
Motivation and Context
Make usage of tau easier for new users by documenting the various API endpoints.
How Has This Been Tested?
N/A
Types of changes
Checklist: