diff --git a/CHANGELOG.md b/CHANGELOG.md index ee1c95fab..1f4927ef2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -39,7 +39,7 @@ ## v3.0.0 (_11-03-2024_) -- Highlight: [EmulatorJS player](https://github.com/rommapp/romm/wiki/EmulatorJS-Player): Play retro games in your web browser +- Highlight: [EmulatorJS player](https://docs.romm.app/latest/Platforms-and-Players/EmulatorJS-Player): Play retro games in your web browser - Highlight: Saves and states: Upload/downlaod game saves, and play them with EmulatorJS - Highlight: More metadata: Extracts more information from IGDB, like release date, genres, related games, etc. - Highlight: New license: Now licensed under AGPL-3.0 to promote community contributions diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8060e2c59..41b6cea00 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,7 +10,7 @@ Please note that this project adheres to the Contributor Covenant [code of condu ## Contributing to the Wiki -If you would like to contribute to the project's [documentation](https://github.com/rommapp/romm/wiki), open a pull request against [the wiki repo](https://github.com/rommapp/wiki). We welcome any contributions that help improve the documentation (new pages, updates, or corrections). +If you would like to contribute to the project's [documentation](https://docs.romm.app), open a pull request against [the docs repo](https://github.com/rommapp/docs). We welcome any contributions that help improve the documentation (new pages, updates, or corrections). ## Adding Translations diff --git a/examples/docker-compose.example.yml b/examples/docker-compose.example.yml index 0e43eef60..cd039b8b6 100644 --- a/examples/docker-compose.example.yml +++ b/examples/docker-compose.example.yml @@ -17,9 +17,11 @@ services: - DB_PASSWD= # Should match MARIADB_PASSWORD in mariadb - ROMM_AUTH_SECRET_KEY= # Generate a key with `openssl rand -hex 32` - IGDB_CLIENT_ID= # Generate an ID and SECRET in IGDB - - IGDB_CLIENT_SECRET= # https://api-docs.igdb.com/#account-creation - - MOBYGAMES_API_KEY= # https://www.mobygames.com/info/api/ - - STEAMGRIDDB_API_KEY= # https://github.com/rommapp/romm/wiki/Generate-API-Keys#steamgriddb + - IGDB_CLIENT_SECRET= # https://docs.romm.app/latest/Getting-Started/Generate-API-Keys/#igdb + - MOBYGAMES_API_KEY= # https://docs.romm.app/latest/Getting-Started/Generate-API-Keys/#mobygames + - STEAMGRIDDB_API_KEY= # https://docs.romm.app/latest/Getting-Started/Generate-API-Keys/#steamgriddb + - SCREENSCRAPER_USER= # Use your ScreenScraper username and password + - SCREENSCRAPER_PASSWORD= # https://docs.romm.app/latest/Getting-Started/Generate-API-Keys/#screenscraper volumes: - romm_resources:/romm/resources # Resources fetched from IGDB (covers, screenshots, etc.) - romm_redis_data:/redis-data # Cached data for background tasks