cliff-ai 1.0.0 → 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Raj Shah
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -39,87 +39,66 @@ A terminal-first AI coding assistant built with **Node.js, Groq, LangChain, and
 
 ### A quick look at the workflow
 
-```text
-$ cliff
-
-  CLIFF.
-  THE EDGE IS YOURS.
-
-  > Read calculator.js and add input validation to multiply().
-
-  ◇ Reading calculator.js
-  ◇ Preparing an edit
-
-  Proposed changes: calculator.js
-  ─────────────────────────────────────────
-  - return a * b;
-  + if (typeof a !== "number" || typeof b !== "number") {
-  +   throw new TypeError("Expected numbers");
-  + }
-  + return a * b;
-
-  Apply this change? [y/N] y
-  ✓ File updated
-```
+![CLI Screenshot](https://ik.imagekit.io/hqhsgjeub/clif/image.png)
 
 <sub>Illustrative terminal session; exact visual output depends on the current CLI UI.</sub>
 
-## 🚀 Getting started
+
+## 🚀 Getting Started
 
 ### Prerequisites
 
-- A recent Node.js version and npm
-- A [Groq API key](https://console.groq.com/keys)
-- A terminal and a project folder to work in
+- **Node.js** (v20 or later recommended)
+- A free [Groq API Key](https://console.groq.com/keys)
+- A terminal and a project to work on
+
+### 1. Install CLIFF
 
-### 1. Clone and install
+Install globally using npm:
 
 ```bash
-git clone <YOUR_REPOSITORY_URL>
-cd <YOUR_REPOSITORY_FOLDER>
-npm install
+npm install -g cliff-ai
 ```
 
-### 2. Link CLIFF as a local CLI command
+Or run directly without installing:
 
 ```bash
-npm link
+npx cliff-ai
 ```
 
-This makes the CLI command available globally **on your machine** from the local repository. It does not publish CLIFF to npm.
+### 2. Launch CLIFF
 
-### 3. Open the project you want to work on
+Navigate to your project directory and start CLIFF:
 
 ```bash
 cd path/to/your/project
 cliff
 ```
 
-On first launch, follow CLIFF's setup prompts to configure your Groq API key and model. Configuration is stored locally in CLIFF's settings file.
+On your first launch, CLIFF will guide you through configuring your **Groq API key** and selecting an AI model.
 
 > [!IMPORTANT]
-> Run CLIFF **inside the project directory** you intend to work on. CLIFF uses the current working directory as its workspace. Review every proposed write before approving it, and avoid using real secrets or irreplaceable files while testing.
+> Always launch CLIFF **inside your project directory**. CLIFF treats the current working directory as its workspace. Review file modifications before approving them.
 
-### Try these prompts
+### 3. Start Building ✨
 
-```text
-Read README.md and summarize the project's structure.
-```
+Try asking CLIFF:
 
 ```text
-Create a utils.js file with a function that validates an email address.
-```
+> Read README.md and explain this project.
 
-```text
-Read calculator.js and update only the multiply function to reject non-number inputs.
-```
+> Create a utils.js file with an email validation function.
 
-```text
-List the files in the current directory and tell me where the entry point might be.
+> Update the multiply function in calculator.js to handle invalid inputs.
+
+> List all files and identify the project's entry point.
 ```
 
-> [!NOTE]
-> Available slash commands and model names can depend on your current CLIFF build. Use the in-app help command, if available, for the authoritative list.
+### 🔗 Useful Links
+
+[![npm](https://img.shields.io/npm/v/cliff-ai?style=for-the-badge&logo=npm&logoColor=white&color=CB3837)](https://www.npmjs.com/package/cliff-ai)
+
+> **CLIFF v1** focuses on reading, creating, and updating project files with AI-powered assistance and user-controlled approvals.
 
 ## 🧰 Tech stack
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cliff-ai",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "CLIFF — An AI-powered terminal coding assistant. The edge is yours.",
   "main": "index.js",
   "bin": {
@@ -18,7 +18,7 @@
     "README.md",
     "LICENSE"
   ],
-  "keywords": [ 
+  "keywords": [
     "cliff",
     "ai",
     "coding-assistant",