feat(ci): sync dockerhub overview with github readme (#11)

* feat(ci): sync dockerhub overview with github reade

* fix: missing checkout in tmp

* fix: try another action

* fix: use yet another action

* docs: cleanup README to upload to dockerhub

.github/workflows/quality.yml

@@ -10,12 +10,9 @@ on:
 permissions:
     contents: read
 
-defaults:
-  run:
-    shell: bash
-
 jobs:
-  quality:
+  lint:
+    name: Run linters
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
@@ -24,7 +21,7 @@ jobs:
       with:
         go-version: '^1.21'
 
-    - name: golangci-lint
+    - name: Run golangci-lint
       uses: golangci/golangci-lint-action@v3
       with:
         version: v1.55
@@ -39,5 +36,5 @@ jobs:
       with:
         go-version: '^1.21'
 
-    - name: go test
+    - name: Run unit tests
       run: go test -v ./...

.github/workflows/release.yml

@@ -5,6 +5,9 @@ on:
     tags:
       - 'v*'
 
+permissions:
+  contents: read
+
 jobs:
   push_to_registry:
     name: Push Docker image to Docker Hub
@@ -36,3 +39,11 @@ jobs:
           push: true
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
+
+      - name: Update Docker Hub description
+        uses: peter-evans/dockerhub-description@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+          repository: cyclimse/scwtui
+          short-description: ${{ github.event.repository.description }}

README.md

@@ -1,9 +1,9 @@
 # scwtui
 
-> **Note**
+> **Warning**
 > Not an official Scaleway project, use at your own risk.
 
-`scwtui` is a terminal user interface for Scaleway powered by [bubbletea](https://github.com/charmbracelet/bubbletea). Inspired by [k9s](https://k9scli.io/).
+`scwtui` is a terminal user interface for Scaleway powered by [bubbletea](https://github.com/charmbracelet/bubbletea).
 
 It allows you to view all the resources in your Scaleway account and perform basic operations on them.
 
@@ -12,9 +12,11 @@ It allows you to view all the resources in your Scaleway account and perform bas
 The easiest way to run `scwtui` is to use Docker.
 
 ```bash
-docker run -it --rm -v "$HOME/.config/scw:/root/.config/scw" cyclimse/scwtui:0.1.0
+docker run -it --rm -v "$HOME/.config/scw:/root/.config/scw" cyclimse/scwtui:0.1.1
 ```
 
+You can also provide your Scaleway credentials using environment variables. See the [scaleway-cli](https://github.com/scaleway/scaleway-cli/blob/master/docs/commands/config.md) documentation for more information.
+
 ## Keybindings
 
 | Keybinding      | Description                             |
@@ -48,9 +50,7 @@ You can delete a resource by pressing `x` when it is selected. This will prompt
 
 You can view the logs for a resource by pressing `l` when it is selected. This will open a new window with the logs for the resource.
 
-In practice, this feature relies on the Cockpit Loki API. It will generate tokens for each project to allow you to view the logs for the project.
-
-This requires your API key to have the `ObservabilityFullAccess` permission set to work.
+This feature relies on the Cockpit Loki API. It will generate a token for each project to allow you to view the logs of the resources in the project. As such, you will need to provide the `ObservabilityFullAccess` permission set to your API token.
 
 ## Supported Resources
 
@@ -60,3 +60,11 @@ This requires your API key to have the `ObservabilityFullAccess` permission set
 | Serverless Container | ✅    | ✅        | ✅      | ✅    |
 | Registry Namespace   | ✅    | ✅        | ✅      | ❌    |
 | RDB Instance         | ✅    | ✅        | ✅      | ✅    |
+
+## Troubleshooting
+
+### IAM Permissions
+
+If you're using an IAM scoped token, you will need to provide the `ProjectReadyOnly` permission set to your API token. This is needed to retrieve the projects in your account, so that all resources can be listed.
+
+In addition, you will need read permissions for all the products you want to use with `scwtui`. For instance, if you want to use this tool with all products, you can use the `AllProductsReadOnly` permission set.