Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 25 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand All @@ -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
Expand Down Expand Up @@ -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"
Expand Down
Loading