Skip to content

Commit 75e2468

Browse files
docs: update readme with how to use release
1 parent bdfe2ff commit 75e2468

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,13 @@ This tool acts as your personalized, AI-powered commit assistant. Rather than fo
1515
2. A **GitHub Personal Access Token** (to securely fetch organization commits)
1616
3. A **Google Gemini API Key** (for cluster semantic naming inferencing)
1717

18-
## Setup & Installation
18+
## Using the Release (Quick Start)
19+
20+
1. **Install .NET**: Ensure you have the [.NET 9 Runtime or SDK](https://dotnet.microsoft.com/download/dotnet/9.0) installed.
21+
2. **Download**: Go to [v0.9-alpha](https://github.com/abhitrueprogrammer/git-commit-categorize/releases/tag/v0.9-alpha) and download the `.zip` file for your platform.
22+
3. **Unzip & Run**: Extract the zip, setup your `.env` file (see below), and run the executable directly in the unzipped folder.
23+
24+
## Setup & Installation (Manual Build)
1925

2026
1. **Clone the repository:**
2127
```bash

0 commit comments

Comments
 (0)