From 990c319b9f9ce28600740d106cd87daded55c434 Mon Sep 17 00:00:00 2001
From: Mircea-Pavel ANTON <contact@mirceanton.com>
Date: Mon, 12 Aug 2024 18:14:02 +0000
Subject: [PATCH] chore: update README

---
 README.md | 102 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 101 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index a4e557a..e3a70be 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,102 @@
 # talswitcher
-A simple tool to help manage multiple talosconfig files
+
+`talswitcher` is a command-line tool for managing and switching between different Talos contexts. It simplifies the process of selecting a Talos context from multiple talosconfig files and updates the active configuration.
+
+## Features
+
+- **Non-Interactive Mode**: Specify the desired context directly as an argument.
+- **Automatic Configuration Update**: Copies the selected context's talosconfig to the appropriate location for Talos.
+- **Duplicate Context Detection**: Ensures there are no duplicate context names across multiple talosconfig files.
+
+## Installation
+
+### Download Precompiled Binaries
+
+Precompiled binaries are available for various platforms. You can download the latest release from the [GitHub Releases page](https://github.com/mirceanton/talswitcher/releases/latest).
+
+1. Download the appropriate binary for your system and extract the archive.
+2. Make the extracted binary executable:
+
+    ```bash
+    chmod +x talswitcher
+    ```
+
+3. Move the binary to a directory in your PATH:
+
+    ```bash
+    mv talswitcher /usr/local/bin/
+    ```
+
+### Build from Source
+
+1. Clone the repository:
+
+    ```bash
+    git clone https://github.com/mirceanton/talswitcher
+    cd talswitcher
+    ```
+
+2. Build the tool:
+
+    If you have [Taskfile](https://taskfile.dev/) installed, run:
+
+    ```bash
+    task build
+    ```
+
+    Otherwise, simply run the `go build` command:
+
+    ```bash
+    go build -o talswitcher
+    ```
+
+### Running via Docker
+
+`talswitcher` is also available as a Docker container:
+
+```bash
+docker pull ghcr.io/mirceanton/talswitcher
+```
+
+## Usage
+
+`talswitcher` can be used both interactively and non-interactively.
+
+### Interactive Mode
+
+If no context name is provided, `talswitcher` will list all available contexts and prompt you to choose one:
+
+```bash
+talswitcher --talosconfig-dir /path/to/talosconfigs
+```
+
+### Non-Interactive Mode
+
+You can also specify a context name directly:
+
+```bash
+talswitcher my-context --talosconfig-dir /path/to/talosconfigs
+```
+
+This will switch to `my-context` immediately.
+
+## Configuration
+
+You can configure `talswitcher` using environment variables or CLI flags. The following table outlines the available options:
+
+|   Environment Variable   |      CLI Flag       |                     Description                     |                      Acceptable Values                      |   Default Value   |
+| :----------------------: | :-----------------: | :-------------------------------------------------: | :---------------------------------------------------------: | :---------------: |
+| `TALSWITCHER_LOG_LEVEL`  |    `--log-level`    |        Controls the logging verbosity level.        | `panic`, `fatal`, `error`, `warn`, `info`, `debug`, `trace` |      `info`       |
+| `TALSWITCHER_LOG_FORMAT` |   `--log-format`    |           Controls the log output format.           |                       `json`, `text`                        |      `text`       |
+|    `TALOSCONFIG_DIR`     | `--talosconfig-dir` |    Directory containing your talosconfig files.     |                  Any valid directory path                   |       `N/A`       |
+|      `TALOSCONFIG`       |        `N/A`        | Path where the selected talosconfig will be copied. |                     Any valid file path                     | `~/.talos/config` |
+
+When both the environment variable and CLI flag are set, the CLI flag takes precedence.
+
+## Contributing
+
+Contributions are welcome! Please fork the repository, make your changes, and submit a pull request.
+
+## License
+
+This project is licensed under the MIT License. See the LICENSE file for more details.