@riflo/ryte 1.0.1 → 1.1.1

package/README.md

@@ -2,17 +2,21 @@
 
 > **Write it right.** AI-powered Git workflow CLI for developers who care about clean history and velocity.
 
+*Turn messy git logs into structured, semantic history — instantly.*
+
 [![npm version](https://img.shields.io/npm/v/@riflo/ryte.svg?style=flat-square)](https://www.npmjs.com/package/@riflo/ryte)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://opensource.org/licenses/MIT)
 [![Node Version](https://img.shields.io/badge/node-%3E%3D18.0.0-brightgreen.svg?style=flat-square)](https://nodejs.org)
 
 ---
 
+![RYTE Demo](demo.gif)
+
 ## Introduction
 
 Writing meaningful commit messages and well-structured Pull Requests is critical for team collaboration, but it’s often a friction point in a fast-paced development cycle. 
 
-**ryte** is your CLI companion that bridge the gap between "coding" and "documenting". It reads your git diffs, understands the context of your changes, and generates professional, semantic-compliant messages in seconds.
+**ryte** is your CLI companion that **bridges** the gap between "coding" and "documenting". It reads your git diffs, understands the context of your changes, and generates professional, semantic-compliant messages in seconds.
 
 ### Core Value
 - **Zero Friction**: Stay in the terminal. No Web UI, no heavy extensions.
@@ -29,7 +33,10 @@ Writing meaningful commit messages and well-structured Pull Requests is critical
 npm install -g @riflo/ryte
 
 # 2. Set your free AI key (get one at console.groq.com)
+# Mac/Linux:
 export GROQ_API_KEY="gsk_..."
+# Windows (PowerShell):
+$env:GROQ_API_KEY="gsk_..."
 
 # 3. Stage your changes and go
 git add .
@@ -56,7 +63,19 @@ With `ryte c`, it looks like this:
 ✅  chore: update dependencies to remove security vulnerabilities
 ```
 
-One command. Same diff. Zero manual thinking.
+### See the Magic
+
+**What RYTE sees (`git diff --staged`):**
+```diff
++ const refreshToken = generateToken(user.id)
++ await saveTokenToDB(refreshToken)
++ return res.cookie('refresh_token', refreshToken, { httpOnly: true })
+```
+
+**What RYTE writes:**
+> `feat(auth): implement JWT refresh token rotation via HTTP-only cookies`
+
+One command. Same diff. Clean history.
 
 ---
 
@@ -141,7 +160,8 @@ Fair question. Here's an honest comparison:
 | Free tier available | ❌ | ✅ (via Groq) |
 | BYOK (Bring Your Own Key) | ❌ | ✅ |
 
-Copilot is great for writing code. RYTE is for **documenting the intent** behind it.
+*Copilot helps you write code.*  
+**RYTE helps your future self understand it.**
 
 ---
 
@@ -165,7 +185,7 @@ We understand that sending code to an external API is a sensitive decision. Here
 
 ## Configuration
 
-**ryte** requires an API key to function. We support two providers:
+**ryte** requires an API key to function. We support high-performance LLM providers like Groq and OpenAI.
 
 ### Groq (Recommended - Free & Instant)
 Get your free key at [console.groq.com](https://console.groq.com/keys).
@@ -205,7 +225,7 @@ We believe that **every commit should be written right**. A clean git history is
 
 Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
 
-Please see [CONTRIBUTING.md](file:///d:/pact/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests.
+Please see our [Contributing Guide](https://github.com/Rifuroo/ryte/blob/main/CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.
 
 ---
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riflo/ryte",
-  "version": "1.0.1",
+  "version": "1.1.1",
   "description": "AI Git Workflow Assistant - Generate semantic commits and PRs",
   "main": "src/index.js",
   "bin": {

package/src/index.js

@@ -128,14 +128,24 @@ async function main() {
         await handlePR();
     } else {
         console.log(`
-\x1b[36mRYTE - AI Git Workflow Assistant\x1b[0m
-Author: Riflo
-
-Usage:
-  ryte c    Generate semantic commit from staged diff
-  ryte pr   Generate PR markdown description from branch commits
-
-Set GROQ_API_KEY (Free) or OPENAI_API_KEY environment variable.
+ \x1b[1;38;5;39m██████╗ \x1b[1;38;5;63m██╗   ██╗\x1b[1;38;5;129m████████╗\x1b[1;38;5;161m███████╗\x1b[0m
+ \x1b[1;38;5;39m██╔══██╗\x1b[1;38;5;63m╚██╗ ██╔╝\x1b[1;38;5;129m╚══██╔══╝\x1b[1;38;5;161m██╔════╝\x1b[0m
+ \x1b[1;38;5;39m██████╔╝\x1b[1;38;5;63m ╚████╔╝ \x1b[1;38;5;129m   ██║   \x1b[1;38;5;161m█████╗  \x1b[0m
+ \x1b[1;38;5;39m██╔══██╗\x1b[1;38;5;63m  ╚██╔╝  \x1b[1;38;5;129m   ██║   \x1b[1;38;5;161m██╔══╝  \x1b[0m
+ \x1b[1;38;5;39m██║  ██║\x1b[1;38;5;63m   ██║   \x1b[1;38;5;129m   ██║   \x1b[1;38;5;161m███████╗\x1b[0m
+ \x1b[1;38;5;39m╚═╝  ╚═╝\x1b[1;38;5;63m   ╚═╝   \x1b[1;38;5;129m   ╚═╝   \x1b[1;38;5;161m╚══════╝\x1b[0m
+
+  \x1b[90mAI-Powered Git Workflow Assistant\x1b[0m
+  \x1b[90mv1.1.1 | by Riflo\x1b[0m
+
+  \x1b[33mCOMMANDS:\x1b[0m
+  \x1b[32mryte c\x1b[0m     Generate semantic commit from diff
+  \x1b[32mryte pr\x1b[0m    Generate PR markdown from branch commits
+
+  \x1b[33mGETTING STARTED:\x1b[0m
+  Set either environment variable to unleash the AI:
+  • \x1b[36mGROQ_API_KEY\x1b[0m   (Recommended / Free tier)
+  • \x1b[36mOPENAI_API_KEY\x1b[0m (OpenAI API key)
         `);
     }
 

package/src/prompt.js

@@ -15,6 +15,7 @@ RULES:
 6. Scope: If the diff is localized, infer a scope (e.g., "auth", "ui", "config").
 7. Body (Optional): If the change is complex, add a brief body after 1 blank line to explain technical nuances.
 8. Context: If a branch name or ticket is provided, incorporate it into the scope or footer if applicable.
+9. Anti-Plagiarism: If the diff shows documentation changes containing example commit messages, DO NOT copy those examples. Always synthesize a new message describing the actual change.
 
 Example:
 feat(ui): add loading state to checkout button