Skip to content

Commit ffdc283

Browse files
committed
Enhance README with awesome badges, npm links, and visual elements
1 parent 52fd5ed commit ffdc283

1 file changed

Lines changed: 157 additions & 8 deletions

File tree

README.md

Lines changed: 157 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,17 @@
11
# Cursorifier
22

3-
[![npm version](https://img.shields.io/npm/v/cursorifier.svg)](https://www.npmjs.com/package/cursorifier)
4-
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
5-
[![Node.js Version](https://img.shields.io/node/v/cursorifier.svg)](https://nodejs.org/)
3+
<div align="center">
4+
5+
[![npm version](https://img.shields.io/npm/v/cursorifier.svg?style=for-the-badge)](https://www.npmjs.com/package/cursorifier)
6+
[![npm downloads](https://img.shields.io/npm/dm/cursorifier.svg?style=for-the-badge)](https://www.npmjs.com/package/cursorifier)
7+
[![GitHub stars](https://img.shields.io/github/stars/rainmana/cursorifier.svg?style=for-the-badge&label=Stars)](https://github.com/rainmana/cursorifier)
8+
[![GitHub forks](https://img.shields.io/github/forks/rainmana/cursorifier.svg?style=for-the-badge&label=Forks)](https://github.com/rainmana/cursorifier)
9+
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge)](https://opensource.org/licenses/MIT)
10+
[![Node.js Version](https://img.shields.io/node/v/cursorifier.svg?style=for-the-badge)](https://nodejs.org/)
11+
12+
[![GitHub stars over time](https://starchart.cc/rainmana/cursorifier.svg)](https://starchart.cc/rainmana/cursorifier)
13+
14+
</div>
615

716
**Supercharge your Cursor AI with codebase-specific intelligence.** Cursorify transforms your GitHub repositories into custom rules that teach Cursor AI how your project works, resulting in more accurate code suggestions, better refactoring, and contextually aware assistance. Now supports multiple LLM providers including Anthropic Claude, OpenAI, and local models like Ollama.
817

@@ -25,16 +34,94 @@
2534
- 📝 Create production-ready .rules.mdc files for immediate use
2635
- 🔧 Customize analysis with flexible configuration options
2736

28-
## Installation
37+
## 🚀 Installation
38+
39+
### Quick Install (Recommended)
2940

3041
```bash
31-
# Install globally
42+
# Install globally from npm
3243
npm install -g cursorifier
3344

3445
# Or use with npx (no installation required)
3546
npx cursorifier
3647
```
3748

49+
### Alternative Installation Methods
50+
51+
```bash
52+
# Install from GitHub (latest development version)
53+
npm install -g https://github.com/rainmana/cursorifier.git
54+
55+
# Or clone and install locally
56+
git clone https://github.com/rainmana/cursorifier.git
57+
cd cursorifier
58+
npm install
59+
npm link
60+
```
61+
62+
### Verify Installation
63+
64+
```bash
65+
cursorifier --version
66+
cursorifier --list-providers
67+
```
68+
69+
📦 **Available on [npmjs.com](https://www.npmjs.com/package/cursorifier)**
70+
71+
## 🎬 Quick Demo
72+
73+
```bash
74+
# Generate rules for any GitHub repository
75+
cursorifier https://github.com/facebook/react
76+
77+
# Use with local models (Ollama)
78+
cursorifier . --provider local --base-url http://localhost:11434 --model llama2
79+
80+
# Use existing repomix output
81+
cursorifier --repomix-file ./my-repo-analysis.xml
82+
```
83+
84+
## ✨ What Makes Cursorifier Special?
85+
86+
<table>
87+
<tr>
88+
<td width="50%">
89+
90+
### 🧠 **Intelligent Analysis**
91+
- Analyzes your entire codebase structure
92+
- Identifies patterns, conventions, and architecture
93+
- Understands your project's unique characteristics
94+
95+
</td>
96+
<td width="50%">
97+
98+
### 🚀 **Multi-Provider Support**
99+
- **Anthropic Claude** - Most intelligent analysis
100+
- **OpenAI GPT** - Fast and reliable
101+
- **Local Models** - Privacy-focused with Ollama/LM Studio
102+
103+
</td>
104+
</tr>
105+
<tr>
106+
<td width="50%">
107+
108+
### 📊 **Smart Chunking**
109+
- Handles repositories of any size
110+
- Intelligent content segmentation
111+
- Optimized for LLM token limits
112+
113+
</td>
114+
<td width="50%">
115+
116+
### 🎯 **Production Ready**
117+
- Generates `.rules.mdc` files
118+
- Drop-in Cursor AI integration
119+
- Zero configuration required
120+
121+
</td>
122+
</tr>
123+
</table>
124+
38125
## Prerequisites
39126

40127
- Node.js 18 or higher
@@ -140,6 +227,30 @@ Options:
140227
- **API Key**: Optional (`LOCAL_API_KEY`)
141228
- **Best for**: Privacy, offline usage, and custom models
142229

230+
## 📊 Provider Comparison
231+
232+
| Feature | Anthropic Claude | OpenAI | Local Models |
233+
|---------|------------------|--------|--------------|
234+
| **Quality** | ⭐⭐⭐⭐⭐ | ⭐⭐⭐⭐ | ⭐⭐⭐ |
235+
| **Speed** | ⭐⭐⭐ | ⭐⭐⭐⭐⭐ | ⭐⭐⭐⭐ |
236+
| **Cost** | ⭐⭐ | ⭐⭐⭐ | ⭐⭐⭐⭐⭐ |
237+
| **Privacy** | ⭐⭐ | ⭐⭐ | ⭐⭐⭐⭐⭐ |
238+
| **Offline** ||||
239+
| **Custom Models** ||||
240+
241+
## 🎯 Use Cases
242+
243+
<div align="center">
244+
245+
| **Use Case** | **Recommended Provider** | **Why** |
246+
|--------------|-------------------------|---------|
247+
| 🏢 **Enterprise Projects** | Anthropic Claude | Best code understanding and analysis |
248+
| 🚀 **Rapid Prototyping** | OpenAI | Fast and cost-effective |
249+
| 🔒 **Sensitive Codebases** | Local Models | Complete privacy and control |
250+
| 🎓 **Learning Projects** | Local Models | Free and educational |
251+
252+
</div>
253+
143254
### Setting up Local Models
144255

145256
#### Ollama
@@ -247,11 +358,37 @@ If you encounter rate limits or ihigh costs, try to minimize the context length
247358
### Original Project Credits
248359
This project is based on the excellent work of [niklub](https://github.com/niklub) and their original [rulefy](https://github.com/niklub/rulefy) project. We're grateful for their foundational work that made this enhanced version possible.
249360

250-
## Contributing
361+
## 🤝 Contributing
251362

252-
Contributions are welcome! Please feel free to submit a Pull Request.
363+
We love contributions! Here's how you can help:
253364

254-
## Acknowledgements
365+
- 🐛 **Report bugs** - Found an issue? Open a [GitHub Issue](https://github.com/rainmana/cursorifier/issues)
366+
- 💡 **Suggest features** - Have an idea? We'd love to hear it!
367+
- 🔧 **Submit PRs** - Fix bugs or add features
368+
- 📖 **Improve docs** - Help others learn how to use Cursorifier
369+
370+
### Development Setup
371+
372+
```bash
373+
git clone https://github.com/rainmana/cursorifier.git
374+
cd cursorifier
375+
npm install
376+
npm run build
377+
npm link
378+
```
379+
380+
## 📈 Stats & Analytics
381+
382+
<div align="center">
383+
384+
[![GitHub commit activity](https://img.shields.io/github/commit-activity/m/rainmana/cursorifier?style=for-the-badge)](https://github.com/rainmana/cursorifier)
385+
[![GitHub last commit](https://img.shields.io/github/last-commit/rainmana/cursorifier?style=for-the-badge)](https://github.com/rainmana/cursorifier)
386+
[![GitHub issues](https://img.shields.io/github/issues/rainmana/cursorifier?style=for-the-badge)](https://github.com/rainmana/cursorifier/issues)
387+
[![GitHub pull requests](https://img.shields.io/github/issues-pr/rainmana/cursorifier?style=for-the-badge)](https://github.com/rainmana/cursorifier/pulls)
388+
389+
</div>
390+
391+
## 🏆 Acknowledgements
255392

256393
This project is inspired by and builds upon the work of:
257394

@@ -262,3 +399,15 @@ This project is inspired by and builds upon the work of:
262399

263400
We're grateful to these projects for their contributions to the developer tooling ecosystem.
264401

402+
---
403+
404+
<div align="center">
405+
406+
**⭐ Star this repo if you find it helpful!**
407+
408+
[![GitHub stars](https://img.shields.io/github/stars/rainmana/cursorifier?style=social)](https://github.com/rainmana/cursorifier)
409+
410+
Made with ❤️ by [rainmana](https://github.com/rainmana)
411+
412+
</div>
413+

0 commit comments

Comments
 (0)