From f1774d7c84e9f3b3f5561c7acb1b6749b86fc16d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=81lvaro=20Mart=C3=ADnez?=
 <alvaro.mart.mart+dev@gmail.com>
Date: Thu, 14 Mar 2024 10:23:22 +0000
Subject: [PATCH] chore: update README

---
 README.md | 31 ++++++++++++++++++++++++++++++-
 1 file changed, 30 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 48696f9..233dade 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,31 @@
 # setup-seqerakit
-Github Action to set up seqerakit
+
+A Github Action to set up everything needed to run [`seqerakit`](https://github.com/seqeralabs/seqera-kit), including setup of [`tower-cli`](https://github.com/seqeralabs/tower-cli) if not found already in the Github Action runner environment.
+## Usage
+
+```yml
+  - name: Compare coverage
+    uses: alvaromartmart/setup-seqerakit@v1
+    with:
+      api-endpoint: "https://tower.nf/api"
+      token: ${{ secrets.SEQERA_PLATFORM_PERSONAL_ACCESS_TOKEN }}
+  - name: Use seqerakit
+    run: |
+      seqerakit my_data.yml
+```
+
+### Action inputs
+
+| Name | Description | Default |
+| --- | --- | --- |
+| `token` | Personal access token defined in Seqera Platform. Store it as a Github secret to avoid disclosing it. | - |
+| `api-endpoint` | Seqera platform API endpoint | https://tower.nf/api
+
+
+#### Outputs
+
+None
+
+## License
+
+[MIT](LICENSE)
\ No newline at end of file