Gittes-archive/ow-mod-db
2
0
Fork 0
mirror of https://github.com/ow-mods/ow-mod-db.git synced 2025-12-11 20:15:24 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update readme to reflect new repo structure

Browse Source
This commit is contained in:
Raicuparta 2021-05-13 18:29:17 +02:00 committed by GitHub
parent 01ed583071
commit efe3e2abc5
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -1,10 +1,10 @@
# Outer Wilds Mod Database
Uses the mod list in `mods.json`, and for each mod it will fetch the required data. That data is then added to `database.json`. This process is repeated every 5 minutes.
Uses the mod list in [`mods.json` of the `source`](https://github.com/Raicuparta/ow-mod-db/blob/source/mods.json) branch, fetches the required data for each mod. That data is then added to [`database.json` in the `master` branch](https://github.com/Raicuparta/ow-mod-db/blob/master/database.json). The process happens automatically every once in a while.
## Adding your mod to the list
Fork this repo, add your mod to the end of the list in `mods.json`, and open a PR. The easiest way to do this is to [edit the file directly in GitHub.com](https://github.com/Raicuparta/outer-wilds-mod-db/edit/master/mods.json), follow the big flashy buttons to fork the repo, and propose the change. Do not edit `database.json` yourself. It will be updated automatically.
Fork this repo, add your mod to the end of the list in `mods.json`, and open a PR. The easiest way to do this is to [edit the file directly in GitHub.com](https://github.com/Raicuparta/outer-wilds-mod-db/edit/source/mods.json), follow the big flashy buttons to fork the repo, and propose the change. Do not edit `database.json` yourself. It will be updated automatically.
### Mod entry format