nocommit 0.0.2 → 0.0.3

package/README.md

@@ -1,15 +1,180 @@
+<div align="center">
+
 # nocommit
 
-To install dependencies:
+**AI-powered git commit messages using Google Gemini**
+
+Never write a commit message again.
+
+[![npm version](https://img.shields.io/npm/v/nocommit)](https://www.npmjs.com/package/nocommit)
+[![License](https://img.shields.io/npm/l/nocommit)](https://github.com/asimar007/no-commit/blob/main/LICENSE)
+
+</div>
+
+---
+
+## Why nocommit?
+
+Writing good commit messages takes time. **nocommit** analyzes your staged changes and generates meaningful, conventional commit messages in seconds using Google's Gemini AI.
+
+```bash
+$ git add .
+$ nocommit
+
+✨ Generated commit message:
+feat: add user authentication with JWT tokens
+
+? What would you like to do?
+❯ Commit
+  Edit
+  Regenerate
+  Cancel
+```
+
+## Quick Start
+
+```bash
+# Install globally
+npm install -g nocommit
+
+# Set your Gemini API key
+nocommit config set GEMINI_API_KEY=your_api_key_here
+
+# Stage changes and generate commit
+git add .
+nocommit
+```
+
+Get your API key from [Google AI Studio](https://aistudio.google.com/apikey).
+
+## Requirements
+
+- Node.js v18 or higher
+- A Google Gemini API key
+
+## Installation
+
+```bash
+npm install -g nocommit
+```
+
+Verify installation:
+
+```bash
+nocommit --version
+```
+
+### Upgrading
+
+```bash
+npm update -g nocommit
+```
+
+## Usage
+
+### Basic Usage
+
+Stage your changes, then run nocommit:
+
+```bash
+git add <files...>
+nocommit
+```
+
+### Command Options
+
+| Flag         | Description                                 |
+| ------------ | ------------------------------------------- |
+| `-a, --all`  | Stage all tracked changes before generating |
+| `-y, --yes`  | Skip confirmation and commit immediately    |
+| `-h, --help` | Show help                                   |
+| `--version`  | Show version number                         |
+
+### Examples
+
+```bash
+# Generate message for staged changes
+nocommit
+
+# Stage all changes and generate message
+nocommit -a
+
+# Stage all and commit without confirmation
+nocommit -ay
+```
+
+### Interactive Menu
+
+After generating a message, you'll see these options:
+
+- **Commit** — Use the message and commit
+- **Edit** — Modify the message before committing
+- **Regenerate** — Get a new suggestion
+- **Cancel** — Exit without committing
+
+## Configuration
+
+Manage settings with `nocommit config`:
 
 ```bash
-bun install
+# View all settings
+nocommit config get
+
+# Get a specific value
+nocommit config get model
+
+# Set a value
+nocommit config set model=gemini-2.0-flash
 ```
 
-To run:
+### Available Options
+
+| Option           | Default            | Description                             |
+| ---------------- | ------------------ | --------------------------------------- |
+| `GEMINI_API_KEY` | —                  | Your Google Gemini API key (required)   |
+| `model`          | `gemini-2.5-flash` | Gemini model to use                     |
+| `maxLength`      | `72`               | Max commit message length (20–500)      |
+| `timeout`        | `30000`            | API timeout in ms (5000–120000)         |
+| `generate`       | `3`                | Number of suggestions to generate (1–5) |
+
+### Example Configuration
 
 ```bash
-bun run index.ts
+# Use a different model
+nocommit config set model=gemini-2.0-flash
+
+# Allow longer commit messages
+nocommit config set maxLength=100
+
+# Generate only one suggestion
+nocommit config set generate=1
+
+# Increase timeout for slow connections
+nocommit config set timeout=60000
 ```
 
-This project was created using `bun init` in bun v1.3.0. [Bun](https://bun.com) is a fast all-in-one JavaScript runtime.
+## How It Works
+
+1. **Diff** — nocommit runs `git diff --staged` to capture your changes
+2. **Analyze** — Changes are sent to Google's Gemini AI
+3. **Generate** — Gemini returns commit message suggestions following conventional commit format
+4. **Commit** — You review, optionally edit, and commit
+
+## Troubleshooting
+
+**"No staged changes found"**  
+Stage files first with `git add <files>` or use `nocommit -a`.
+
+**"API key not configured"**  
+Set your key with `nocommit config set GEMINI_API_KEY=your_key`.
+
+**Request timeout**  
+Increase timeout: `nocommit config set timeout=60000`
+
+## Contributing
+
+Contributions are welcome! Check out the [GitHub repository](https://github.com/asimar007/no-commit) to report issues or submit pull requests.
+
+## Maintainers
+
+- **Asim Sk** — [@asimar007](https://github.com/asimar007)

package/dist/index.js

@@ -9,7 +9,7 @@ import { KnownError, handleCliError } from "./error.js";
 const program = new Command();
 program
     .name("nocommit")
-    .version("0.0.0")
+    .version("0.0.3")
     .description("AI-powered git commit message generator")
     .option("-a, --all", "Stage all tracked changes before committing")
     .option("-y, --yes", "Skip confirmation and commit with first suggestion");

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "nocommit",
-  "version": "0.0.2",
-  "description": "Writes your git commit messages for you with AI using Gemini",
+  "version": "0.0.3",
+  "description": "AI-powered CLI that writes your git commit messages using Google Gemini. Never write a commit message again.",
   "type": "module",
   "main": "dist/index.js",
   "bin": {
@@ -11,16 +11,32 @@
     "build": "tsc",
     "dev": "tsc --watch",
     "start": "node dist/index.js",
-    "prepublishOnly": "npm run build"
+    "prepublishOnly": "npm run build",
+    "type-check": "tsc --noEmit"
   },
   "keywords": [
     "git",
     "commit",
     "ai",
     "gemini",
-    "cli"
+    "cli",
+    "automation",
+    "developer-tools",
+    "commit-message",
+    "ai-tools"
   ],
-  "author": "Asim Sk",
+  "author": {
+    "name": "Asim Sk",
+    "url": "https://github.com/asimar007"
+  },
+  "homepage": "https://github.com/asimar007/no-commit#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/asimar007/no-commit.git"
+  },
+  "bugs": {
+    "url": "https://github.com/asimar007/no-commit/issues"
+  },
   "files": [
     "dist"
   ],
@@ -28,9 +44,7 @@
     "node": ">=18.0.0"
   },
   "devDependencies": {
-    "@types/node": "^25.0.10"
-  },
-  "peerDependencies": {
+    "@types/node": "^25.0.10",
     "typescript": "^5.9.3"
   },
   "dependencies": {