Merge pull request #1 from koppor/patch-1

Create README.md

README.md

@@ -0,0 +1,41 @@
+# texlive-mirrors
+
+This project offers <https://zauguin.github.io/texlive-mirrors/mirrors.json> containing the latest available TeXLive revision for each mirror.
+
+Example:
+
+```json
+  "South America": {
+    "Brazil": {
+      "https://linorg.usp.br/CTAN/systems/texlive/tlnet/": {
+        "status": "Alive",
+        "texlive_version": 2024,
+        "revision": 71481
+      }
+    },
+    "Chile": {
+      "https://ctan.dcc.uchile.cl/systems/texlive/tlnet/": {
+        "status": "Alive",
+        "texlive_version": 2024,
+        "revision": 71486
+      }
+    }
+  },
+```
+
+It does it by checking each mirror.
+This check is done in [main.rs](https://github.com/zauguin/texlive-mirrors/blob/get-tl-mirror-status/src/main.rs), which is available in the `get-tl-mirror-status` branch of this project.
+The final binary is published as container at `ghcr.io/zauguin/get-tl-mirror-status:get-tl-mirror-status`.
+
+This project also generates a file `us`, which contains a list of the freshest TeXLive mirrors in the US.
+It is generated by using the data in `mirrors.json`.
+
+Both the generation as well as the publishing of `mirrors.json` and `us` is done at [pages.yaml](https://github.com/zauguin/texlive-mirrors/blob/trunk/.github/workflows/pages.yaml).
+
+## Generating `mirrors.json` locally
+
+Run
+
+```terminal
+podman run ghcr.io/zauguin/get-tl-mirror-status:get-tl-mirror-status > mirrors.json
+```