| ... | ... |
@@ -6,6 +6,23 @@ Print and check availability of latest versions of [Linux][] [distro][] images. |
| 6 | 6 |
[Linux]: https://en.wikipedia.org/wiki/Linux |
| 7 | 7 |
[distro]: https://en.wikipedia.org/wiki/Linux_distribution |
| 8 | 8 |
|
| 9 |
+## Usage |
|
| 10 |
+ |
|
| 11 |
+``` |
|
| 12 |
+distro-url [test] [<distro> [<variant> [<arch> [<mirror>]]]] |
|
| 13 |
+``` |
|
| 14 |
+ |
|
| 15 |
+- `test`: Optional verbatim prefix to check that the server responds with a |
|
| 16 |
+ non-error code for the [URL][]. |
|
| 17 |
+- `<distro>`, `<variant>`, `<arch>`: Optional [glob][]s to match against the |
|
| 18 |
+ combinations `distro-url` knows about. All default to `*`, which matches |
|
| 19 |
+ everything. |
|
| 20 |
+- `<mirror>`: Optional override of the default server. Probably only useful |
|
| 21 |
+ when the above globs only match a single distro. |
|
| 22 |
+ |
|
| 23 |
+[URL]: https://en.wikipedia.org/wiki/URL |
|
| 24 |
+[glob]: https://en.wikipedia.org/wiki/Glob_(programming) |
|
| 25 |
+ |
|
| 9 | 26 |
## License |
| 10 | 27 |
|
| 11 | 28 |
Licensed under the [ISC License][] unless otherwise noted, see the |
| ... | ... |
@@ -5,3 +5,11 @@ Print and check availability of latest versions of [Linux][] [distro][] images. |
| 5 | 5 |
[`distro-url`]: https://git.rcrnstn.net/rcrnstn/distro-url |
| 6 | 6 |
[Linux]: https://en.wikipedia.org/wiki/Linux |
| 7 | 7 |
[distro]: https://en.wikipedia.org/wiki/Linux_distribution |
| 8 |
+ |
|
| 9 |
+## License |
|
| 10 |
+ |
|
| 11 |
+Licensed under the [ISC License][] unless otherwise noted, see the |
|
| 12 |
+[`LICENSE`][] file. |
|
| 13 |
+ |
|
| 14 |
+[ISC License]: https://choosealicense.com/licenses/isc |
|
| 15 |
+[`LICENSE`]: LICENSE |
| 1 | 1 |
new file mode 100644 |
| ... | ... |
@@ -0,0 +1,7 @@ |
| 1 |
+# [`distro-url`][] |
|
| 2 |
+ |
|
| 3 |
+Print and check availability of latest versions of [Linux][] [distro][] images. |
|
| 4 |
+ |
|
| 5 |
+[`distro-url`]: https://git.rcrnstn.net/rcrnstn/distro-url |
|
| 6 |
+[Linux]: https://en.wikipedia.org/wiki/Linux |
|
| 7 |
+[distro]: https://en.wikipedia.org/wiki/Linux_distribution |