From e8f7d187631f1c9205d9621f919d00a04ae30791 Mon Sep 17 00:00:00 2001
From: Bart van der Braak <bartvdbraak@gmail.com>
Date: Thu, 9 Nov 2023 00:31:44 +0100
Subject: [PATCH] docs: written a proper readme

---
 README.md | 64 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 62 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 8c32cf9..90a7ba9 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,62 @@
-# homebrew-keyweave
-Homebrew Tap for Keyweave
+# Homebrew Keyweave Formula
+
+## Description
+
+This Homebrew formula provides a convenient way to install [Keyweave](https://github.com/bartvdbraak/keyweave) on macOS and Linux systems. Keyweave is a tool that fetches secrets from Azure Key Vault and weaves them into a convenient .env file. This formula supports multiple architectures and libc variations, making it versatile for various system configurations.
+
+## Installation
+
+You can use this formula to install Keyweave using Homebrew. First, tap into this repository:
+
+```bash
+brew tap bartvdbraak/keyweave
+```
+
+Then, install Keyweave:
+
+```bash
+brew install keyweave
+```
+
+## Options
+
+This formula supports a few options that allow you to customize the installation:
+
+- `with-gnu-libc`: Install the glibc binary (GNU C Library).
+- `with-musl-libc`: Install the musl binary (default).
+
+## Version
+
+The current version of Keyweave provided by this formula can be found within the formula file.
+
+## Supported Platforms
+
+This formula supports macOS and Linux, and it is compatible with various CPU architectures.
+
+### macOS
+
+- For Apple Silicon (ARM) Macs
+- For Intel (x86_64) Macs
+
+### Linux
+
+- For ARM Linux systems:
+  - For 32-bit ARM systems
+  - For 64-bit ARM systems
+- For x86_64 Linux systems:
+  - For glibc-based systems (GNU C Library)
+  - For musl-based systems
+
+## Usage
+
+Once you've installed Keyweave, you can use it to fetch secrets from Azure Key Vault and weave them into a convenient .env file. For detailed usage instructions and examples, please refer to the [Keyweave GitHub repository](https://github.com/bartvdbraak/keyweave).
+
+## Automatic Updates
+
+This formula is automatically updated using a GitHub workflow. The source code repository for this formula is [github.com/bartvdbraak/keyweave](https://github.com/bartvdbraak/keyweave).
+
+---
+
+**Note:** This formula is provided under the GNU General Public License version 3 (GPLv3). For more information about the license, please refer to the [LICENSE](LICENSE) file in the formula repository. If you encounter any issues or have questions about the formula, please open an issue on the [GitHub repository](https://github.com/bartvdbraak/homebrew-keyweave).
+
+Enjoy using Keyweave with Homebrew!
\ No newline at end of file