diff --git a/README.md b/README.md index 12762415..6632c72a 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,9 @@ # Magic-Spoiler [![Discord](https://img.shields.io/discord/314987288398659595?label=Discord&logo=discord&logoColor=white)](https://discord.gg/3Z9yzmA) [![Gitter Chat](https://img.shields.io/gitter/room/Cockatrice/Magic-Spoiler)](https://gitter.im/Cockatrice/Magic-Spoiler) # -Magic-Spoiler is a Python script to scrape [Scryfall](https://scryfall.com) to compile XML files (Cockatrice formatted) and application-ready JSON files (MTGJSON formatted) with information about spoiled cards from upcoming sets. +Magic-Spoiler is a Python script to query the [Scryfall](https://scryfall.com) API to compile XML files (Cockatrice formatted) and application-ready JSON files (MTGJSON formatted) with information about spoiled cards from upcoming sets. -## Output [![Build Status](https://github.com/Cockatrice/Magic-Spoiler/workflows/Deploy/badge.svg?branch=master&event=schedule)](https://github.com/Cockatrice/Magic-Spoiler/actions?query=workflow%3ADeploy+event%3Aschedule+branch%3Amaster) ## +## Output [![Build Status](https://github.com/Cockatrice/Magic-Spoiler/workflows/Deploy/badge.svg?branch=master)](https://github.com/Cockatrice/Magic-Spoiler/actions?query=workflow%3ADeploy+event%3Aworkflow_dispatch+event%3Aschedule+branch%3Amaster) ## >**Enable "Download Spoilers Automatically" in `Cockatrice → Settings → Card Sources → Spoilers` to get updates automatically pushed to your client!**
You can also [add the desired .xml file(s) to your customsets folder manually](https://github.com/Cockatrice/Cockatrice/wiki/Custom-Cards-&-Sets#to-add-custom-sets-follow-these-steps) to make Cockatrice use it. @@ -17,8 +17,10 @@ Just looking for XML or JSON files? [They are in our `files` branch!](https://g When run by our CI, the script automatically updates the files and uploads new versions to this branch. ([History of changes](https://github.com/Cockatrice/Magic-Spoiler/commits/files))
GitHub Actions are scheduled to autoamtically run on a daily basis. -## Errors ## -Noticed an error in the card data? Check out our [Contributing file](https://github.com/Cockatrice/Magic-Spoiler/blob/master/.github/CONTRIBUTING.md) for information on how to help! +## Contributing ## +Noticed an error in the card data? Check out our [Contributing file](https://github.com/Cockatrice/Magic-Spoiler/blob/master/.github/CONTRIBUTING.md) for information on how to help fixing it! + +We do happily accept PR's that improve our script as well! ## Running ## @@ -36,8 +38,11 @@ pip install -r requirements.txt $> python -m magic_spoiler ``` -Outputs the following files to `out/` directory:
-`spoiler.xml`, `spoiler.json`
-`{SET_CODE}.xml`, `{SET_CODE}.json` -> **spoiler** → files contain all currently available spoilers from different sets
-> **{SETCODE}** → files contain just the spoiler available for this single set
+### Output ### + +All XML and JSON spoiler files are written to the `out/` directory: + +| File Name | Content | +|:--|:--| +| `spoiler.xml`, `spoiler.json` | files contain **all** currently available spoilers from different **sets** | +| `{SET_CODE}.xml`, `{SET_CODE}.json` | files contain just the spoiler available for this **single set** |