Merge pull request #85 from alecrem/feature/issue-84/update-readme

README.md

@@ -10,18 +10,25 @@ Composes a list of Magic cards legal in the Middle School format.
 
 ## List of Middle School legal cards
 
-You can download the list in the following formats:
+You can download the list of legal cards in the following formats:
 
-- [JSON (Oracle IDs and card names only)](output/middleschool.json)
-- [CSV (Oracle IDs and card names only)](output/middleschool.csv)
-- [JSON (with additional columns)](output/middleschool_extra_fields.json)
-- [CSV (with additional columns)](output/middleschool_extra_fields.csv)
+- [JSON (Oracle IDs and card names only)](static/middleschool.json)
+- [CSV (Oracle IDs and card names only)](static/middleschool.csv)
+- [JSON (with additional columns)](static/middleschool_extra_fields.json)
+- [CSV (with additional columns)](static/middleschool_extra_fields.csv)
+
+The following versions of the list include banned cards with a `banned` column set to `True`:
+
+- [JSON (Oracle IDs and card names only)](static/middleschool_with_banned.json)
+- [CSV (Oracle IDs and card names only)](static/middleschool_with_banned.csv)
+- [JSON (with additional columns)](static/middleschool_extra_fields_with_banned.json)
+- [CSV (with additional columns)](static/middleschool_extra_fields_with_banned.csv)
 
 ## Composing the list
 
-Feel free to take a look at [the Jupyter notebook](https://github.com/alecrem/middleschool-cardlist/blob/main/middleschool-cardlist.ipynb) for a quick idea of the process (outdated version).
+Feel free to take a look at [the Jupyter notebook](https://github.com/alecrem/middleschool-cardlist/blob/main/middleschool-cardlist.ipynb) for a quick idea of the process, but please keep in mind that it is outdated and still included only for quick reference purposes.
 
-To actually compose the list, please run the shell and python scripts in the `list_scripts` directory in order.
+To actually compose the list, run the shell and python scripts in the `list_scripts` directory in order.
 
 ### Requirements
 
@@ -52,4 +59,4 @@ streamlit run Middle_School_Card_Search.py
 ## Next.js web interface (deprecated)
 
 - [Repository](https://github.com/alecrem/middleschool-tutor)
-- [Last version deployed](https://middleschooltutor.vercel.app)
+- [Latest version deployed](https://middleschooltutor.vercel.app)

middleschool-cardlist.ipynb

@@ -7,6 +7,8 @@
    "source": [
     "# middleschool-cardlist\n",
     "\n",
+    "Note: this notebook is only for introductory purposes, and is not the way our list is compiled anymore. See the README for more information.\n",
+    "\n",
     "## Prepare the data\n",
     "\n",
     "Download raw data from [MTGJSON](https://mtgjson.com/) (uncomment and run only once)\n"