From 74b9ae68d45792001293d874a8b5feb6053b62b3 Mon Sep 17 00:00:00 2001 From: andev0x Date: Mon, 10 Nov 2025 17:16:02 +0700 Subject: [PATCH] docs: detailed description --- README.md | 28 +++++++++++++++++++++++++--- 1 file changed, 25 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2066aff..52a11bb 100644 --- a/README.md +++ b/README.md @@ -24,10 +24,12 @@ - **Custom Messages**: Use custom messages with scope and breaking change support - **Zero Configuration**: Works out of the box - **Lightning Fast**: Complete offline operation -- **OpenAI Integration**: Optional AI-powered commit message generation + ## Installation +Gitmit is designed to run everywhere. + ### From Releases Download the latest release for your platform from the [releases page](https://github.com/andev0x/gitmit/releases). @@ -38,9 +40,29 @@ Download the latest release for your platform from the [releases page](https://g git clone https://github.com/andev0x/gitmit.git cd gitmit go build -o gitmit -./gitmit ``` +After building, you can install `gitmit` to your system's PATH. + +#### Linux (Arch Linux Example) + +To install `gitmit` to `/usr/local/bin`: + +```bash +sudo mv gitmit /usr/local/bin +``` + +#### macOS + +To determine where `go` binaries are typically installed on your system, use `which go`. This will help you decide where to move the `gitmit` executable. For example, if `which go` returns `/usr/local/bin/go`, you might move `gitmit` there: + +```bash +sudo mv gitmit /Users/username/go/bin +``` + +Alternatively, you can add the directory containing the `gitmit` executable to your shell's PATH environment variable. + + ## Usage ### Basic Usage @@ -195,7 +217,7 @@ Offers: Gitmit works out of the box with zero configuration. However, you can enhance it with: -### OpenAI Integration +### OpenAI Integration (pending) Set your OpenAI API key for enhanced commit message generation: ```bash export OPENAI_API_KEY="your-api-key"