From 08b9e9b05a09505675ef226ffdeccbacc32aade2 Mon Sep 17 00:00:00 2001
From: Alexandre ABRIOUX <alexandre-abrioux@users.noreply.github.com>
Date: Mon, 11 Nov 2024 13:41:17 +0100
Subject: [PATCH] docs: add configuration section

---
 .github/github-profile-toolbox.yaml | 19 ++--------
 README.md                           | 54 +++++++++++++++++++++++------
 2 files changed, 45 insertions(+), 28 deletions(-)

diff --git a/.github/github-profile-toolbox.yaml b/.github/github-profile-toolbox.yaml
index 22ea849..16d1f73 100644
--- a/.github/github-profile-toolbox.yaml
+++ b/.github/github-profile-toolbox.yaml
@@ -2,27 +2,12 @@ tools:
   Language:
     - html5
     - css3
-    - php
     - javascript
-    - typescript
-    - cplusplus
-    - rust
   Tools:
     - git
     - github
-    - gitlab
-    - debian
-    - archlinux
-    - nixos
-    - npm
-    - yarn
-    - pnpm
+    - githubactions
   IDEs:
     - visualstudiocode
     - jetbrains
-    - webstorm
-    - rustrover
-    - vim
-    - neovim
-    - gnuemacs
-    - nano
\ No newline at end of file
+    - neovim
\ No newline at end of file
diff --git a/README.md b/README.md
index acd0906..16cc9bc 100644
--- a/README.md
+++ b/README.md
@@ -9,14 +9,18 @@ Giving the following configuration passed as an input to the GitHub action:
 
 ```yaml
 tools:
-  IDE:
-    - jetbrains
-    - neovim
   Language:
+    - html5
+    - css3
     - javascript
-    - cplusplus
-    - rust
-    - php
+  Tools:
+    - git
+    - github
+    - githubactions
+  IDEs:
+    - visualstudiocode
+    - jetbrains
+    - neovim
 ```
 
 ; you would get the following output:
@@ -32,9 +36,27 @@ Here is a
   You can find an example
   [here](https://github.com/alexandre-abrioux/alexandre-abrioux/blob/main/README.md?plain=1).
 
-- Add the following workflow file to your profile repository:
+- Add the configuration file to your GitHub profile repository:
+  `.github/github-profile-toolbox.yaml`
 
-`.github/workflows/update-toolbox.yaml`
+```yaml
+tools:
+  Language:
+    - html5
+    - css3
+    - javascript
+  Tools:
+    - git
+    - github
+    - githubactions
+  IDEs:
+    - visualstudiocode
+    - jetbrains
+    - neovim
+```
+
+- Add the following workflow file to your GitHub profile repository:
+  `.github/workflows/update-toolbox.yaml`
 
 ```yaml
 name: Update Toolbox
@@ -63,12 +85,22 @@ jobs:
           reviewers: ${{ github.actor }}
 ```
 
-- Go to your profile repository and under "Settings > Actions > General > Workflow permissions"
-  activate the option "Allow GitHub Actions to create and approve pull requests".
-
 You can find an example
 [here](https://github.com/alexandre-abrioux/alexandre-abrioux/blob/main/.github/workflows/update-toolbox.yaml).
 
+- In your GitHub profile repository, under "Settings > Actions > General > Workflow permissions",
+  activate the option "Allow GitHub Actions to create and approve pull requests".
+
+You're all set!
+
+### Configuration
+
+This GitHub action uses https://shields.io to generate icons in your profile's README,
+and `shield.io` itself uses https://simpleicons.org/ provide logos for brands.
+You can find a list of all available brand names over here:
+https://github.com/simple-icons/simple-icons/blob/develop/slugs.md.
+Use the `Brand slug` name to furnish your configuration file.
+
 ### Override defaults
 
 Use the following input parameters to customize it for your use case: