From 0daca1698cef655d19cf99317fa51915645690df Mon Sep 17 00:00:00 2001 From: Chris Badahdah Date: Mon, 22 Jun 2026 17:33:27 -0700 Subject: [PATCH] Add README.md --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..3d87dae --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# setup-jank + +This action sets up [jank](https://jank-lang.org/) for use in GitHub Actions. + +> [!WARNING] +> Since jank is still in Alpha, this will always download the latest binary +> built from main. + + +## Usage + +```yaml +- name: Setup jank + uses: jank-lang/setup-jank@main +``` + +## Support + +Currently, this action supports Debian/Ubuntu and macOS. Window is **not** supported. + +| OS | Package | +| ------------- | ----------------------------------------------------------- | +| Debian/Ubuntu | [ppa.jank-lang.org](https://ppa.jank-lang.org/) | +| macOS | [homebrew-jank](https://github.com/jank-lang/homebrew-jank) | \ No newline at end of file