Skip to content

Commit

Permalink
docs: add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ReenigneArcher committed Oct 5, 2024
1 parent 7b3807d commit 0434d4d
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# GameDB

[![GitHub Workflow Status (DB)](https://img.shields.io/github/actions/workflow/status/lizardbyte/gamedb/update-db.yml.svg?branch=master&label=update%20db&logo=github&style=for-the-badge)](https://github.com/LizardByte/GameDB/actions/workflows/update-db.yml?query=branch%3Amaster)

This repository clones IGDB to gh-pages to be consumed by LizardByte projects, such as LizardByte/Sunshine.

Information from YouTube API is also added to the database for videos.

## Plans

- [ ] Build with Jekyll
- [ ] Revamp index page
- [ ] Provide an item page for each API item
- [ ] Remove CNAME after next Sunshine release (> v0.23.1)
- [ ] Move python code to `src` directory
- [ ] Add unit tests
- [ ] Add code coverage

0 comments on commit 0434d4d

Please sign in to comment.