@sachinthapa572/lazycommit 1.0.0 → 1.0.1

package/README.md

@@ -5,65 +5,28 @@
 
   </div>
    <p>A CLI that writes your git commit messages for you with AI providers. Never write a commit message again.</p>
-	<a href="https://www.npmjs.com/package/lazycommitz"><img src="https://img.shields.io/npm/v/lazycommitt" alt="Current version"></a>
-	<a href="https://github.com/KartikLabhshetwar/lazycommit"><img src="https://img.shields.io/github/stars/KartikLabhshetwar/lazycommit" alt="GitHub stars"></a>
-	<a href="https://github.com/KartikLabhshetwar/lazycommit/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/lazycommitt" alt="License"></a>
+
 </div>
 
 ---
 
-<div align="center">
-  <a href="https://peerlist.io/code_kartik/project/lazycommit" ><img width="400" height="128" alt="LazyCommit" src="https://github.com/user-attachments/assets/5d54d238-38f4-44f2-b253-3959b2487987" /></a>
-</div>
-
 ## Setup
 
 > The minimum supported version of Node.js is v18. Check your Node.js version with `node --version`.
 
-1. Install _lazycommit_:
+### Prerequisites
 
-   ```sh
-   npm install -g lazycommitt
-   ```
+- Git installed and available in your PATH
+- Node.js `>=18`
 
-### Install via Homebrew (macOS)
+### Install
 
-Install via Homebrew tap:
+Install _lazycommit_ globally:
 
 ```sh
-brew tap KartikLabhshetwar/lazycommit https://github.com/KartikLabhshetwar/lazycommit
-brew install lazycommit
+npm install -g @sachinthapa572/lazycommit
 ```
 
-Upgrade:
-
-```sh
-brew update
-brew upgrade lazycommit
-```
-
-2. Choose your provider:
-   - **Groq** (default): retrieve your API key from [Groq Console](https://console.groq.com/keys)
-   - **GitHub Copilot**: install and login to Copilot CLI:
-
-   ```sh
-   copilot auth login
-   ```
-
-3. Configure lazycommit:
-
-   ```sh
-   lazycommit config
-   ```
-
-   For Groq, you can also set the key directly:
-
-   ```sh
-   lazycommit config set GROQ_API_KEY=<your token>
-   ```
-
-   This creates a `.lazycommit` file in your home directory.
-
 ### Upgrading
 
 Check the installed version with:
@@ -72,10 +35,10 @@ Check the installed version with:
 lazycommit --version
 ```
 
-If it's not the [latest version](https://github.com/KartikLabhshetwar/lazycommit/releases/latest), run:
+If it's not the [latest version](https://github.com/sachinthapa572/lazycommit/releases/latest), run:
 
 ```sh
-npm update -g lazycommitt
+npm update -g @sachinthapa572/lazycommit
 ```
 
 ## Usage
@@ -89,7 +52,7 @@ git add <files...>
 lazycommit
 ```
 
-`lazycommit` passes down unknown flags to `git commit`, so you can pass in [`commit` flags](https://git-scm.com/docs/git-commit).
+`lazycommit` passes unknown flags to `git commit`, so you can pass [`commit` flags](https://git-scm.com/docs/git-commit).
 
 For example, you can stage all changes in tracked files as you commit:
 
@@ -201,6 +164,12 @@ Run:
 lazycommit config
 ```
 
+You can also run the explicit setup mode:
+
+```sh
+lazycommit config setup
+```
+
 This opens a step-by-step setup flow for:
 
 - provider
@@ -274,6 +243,8 @@ lazycommit config set GROQ_API_KEY=<your-api-key> generate=3 locale=en
 
 ### Options
 
+> Note: `generate` supports values from `1` to `5`.
+
 #### GROQ_API_KEY
 
 Required
@@ -341,6 +312,7 @@ Available models by provider:
 - `github`:
 - `gpt-5-mini` (default)
 - `gpt-5.4-mini`
+- `gpt-4o-mini-2024-07-18`
 
 Example:
 
@@ -350,7 +322,7 @@ lazycommit config set provider=github model=gpt-5.4-mini
 
 #### timeout
 
-The timeout for network requests to the Groq API in milliseconds.
+The timeout for provider requests in milliseconds.
 
 Default: `1000` (1 second)
 
@@ -410,9 +382,9 @@ This CLI tool runs `git diff` to grab all your latest code changes, then sends t
 Provider behavior:
 
 - `groq` uses Groq API with `GROQ_API_KEY`
-- `github` uses GitHub Copilot SDK and your local Copilot CLI login session
+- `github` uses GitHub Copilot SDK and your local Copilot CLI login session (`copilot auth login`)
 
-### Large diff handling
+### Large diff handling (automatic)
 
 For large commits that exceed API token limits, lazycommit automatically:
 
@@ -440,7 +412,7 @@ If you get a 413 error, your diff is too large for the API. Try these solutions:
 2. **Use a different model**:
 
    ```sh
-   lazycommit config set model "groq/compound-mini"
+   lazycommit config set model=groq/compound-mini
    ```
 
 3. **Commit in smaller batches**:
@@ -455,33 +427,28 @@ If you get a 413 error, your diff is too large for the API. Try these solutions:
 
 - Check provider settings: `lazycommit config show`
 - For `groq`, verify `GROQ_API_KEY` is set
-- For `github`, run `copilot auth login`
+- For `github`, ensure `copilot` CLI is installed and run `copilot auth login`
 - Verify you have staged changes: `git status`
 - Try excluding large files or using a different model
 
 ### Slow performance with large diffs
 
-- **Use the default model**: `lazycommit config set model "openai/gpt-oss-120b"`
+- **Use the default model**: `lazycommit config set model=openai/gpt-oss-120b`
 - Exclude unnecessary files: `lazycommit --exclude "*.log" --exclude "*.tmp"`
 - Use the built-in large diff handling for better context and accuracy
 - Lower generate count: `lazycommit config set generate=1` (default)
 - Reduce timeout: `lazycommit config set timeout=5000` for faster failures
 
-## Why Groq?
+## Why lazycommit?
 
-- **Fast**: Groq provides ultra-fast inference speeds, especially with the 8B instant model
-- **Cost-effective**: More affordable than traditional AI APIs
-- **Open source models**: Uses leading open-source language models
-- **Reliable**: High uptime and consistent performance
-- **Optimized for commits**: The 8B instant model is perfectly sized for conventional commit generation
+- **Fast workflow**: Generate commit messages directly from staged changes
+- **Provider choice**: Use Groq or GitHub Copilot
+- **Works for large commits**: Built-in compact summaries and context snippets
+- **Flexible output**: Generate one or multiple suggestions and edit before committing
 
 ## Maintainers
 
-- **Kartik Labhshetwar**: [@KartikLabhshetwar](https://github.com/KartikLabhshetwar)
-
-## Contributing
-
-If you want to help fix a bug or implement a feature in [Issues](https://github.com/KartikLabhshetwar/lazycommit/issues), checkout the [Contribution Guide](CONTRIBUTING.md) to learn how to setup and test the project.
+- **Sachin Thapa**: [@sachinthapa572](https://github.com/sachinthapa572)
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sachinthapa572/lazycommit",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Writes your git commit messages for you with AI providers",
   "main": "index.js",
   "keywords": [
@@ -13,8 +13,7 @@
   ],
   "author": "Sachin Thapa",
   "license": "Apache-2.0",
-  "homepage": "https://lazycommit.vercel.app",
-  "repository": "sachin/lazycommit(fork)",
+  "repository": "sachinthapa572/lazycommit",
   "type": "module",
   "publishConfig": {
     "access": "public"
@@ -46,4 +45,4 @@
     "tsx": "^4.20.5",
     "typescript": "^5.9.2"
   }
-}
+}