feat: Adds readme.

README.md

@@ -0,0 +1,28 @@
+# setup-just
+
+An action that set's up `just` to allow using `justfile`'s inside gitea workflows.
+
+## Usage
+
+Let's assume your repository has a `justfile` that has a recipe called `test` that builds and runs
+your tests.
+
+We first use the checkout action that is pulled from `Github`, then we can use this action to setup
+`just`, notice that you must provide the full url and version tag. Then we run the tests using the
+`just` recipe called `test`.
+
+```yaml
+name: CI
+on:
+  push:
+    branches: ["main"]
+jobs:
+  test:
+    name: Run tests.
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: https://git.housh.dev/actions/setup-just@v1
+      - name: Run tests.
+        run: just test
+```