Skip to content

Commit 424bdf6

Browse files
authored
Merge pull request #10 from hexawulf/enhance-readme-codepatchwork
feat: Enhance README.md for CodePatchwork
2 parents 9666613 + b56d5a0 commit 424bdf6

File tree

1 file changed

+74
-12
lines changed

1 file changed

+74
-12
lines changed

README.md

Lines changed: 74 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,72 @@
11
# CodePatchwork 🧩
2+
<div align="center">
23

3-
A visual code snippet manager that combines the visual appeal of Pinterest with the functionality of GitHub Gists. CodePatchwork transforms how developers manage code snippets by replacing scattered text files and notes with a visually appealing, searchable repository.
4+
[![GitHub stars](https://img.shields.io/github/stars/hexawulf/CodePatchwork?style=social)](https://github.com/hexawulf/CodePatchwork/stargazers)
5+
[![Live Demo](https://img.shields.io/badge/🚀_Demo-Live-success?style=flat-square)](https://www.codepatchwork.com)
6+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://opensource.org/licenses/MIT)
7+
8+
**Transform your scattered code snippets into a beautiful, searchable visual library**
9+
10+
*A visual code snippet manager that combines the visual appeal of Pinterest with the functionality of GitHub Gists.*
411

512
![CodePatchwork Banner](codepatchwork-banner.png)
613

14+
</div>
15+
16+
## 🌟 **Try CodePatchwork Live!**
17+
18+
<div align="center">
19+
20+
### **👉 [🚀 EXPERIENCE THE DEMO](https://www.codepatchwork.com) 👈**
21+
22+
*See CodePatchwork in action - no installation required!*
23+
24+
[![Live Demo](https://img.shields.io/badge/🚀_Live_Demo-CodePatchwork.com-blue?style=for-the-badge&logoColor=white)](https://www.codepatchwork.com)
25+
26+
</div>
27+
28+
---
29+
30+
## 📋 Table of Contents
31+
- [🌟 Live Demo](#-try-codepatchwork-live)
32+
- [✨ Features](#-features)
33+
- [🚀 Getting Started](#-getting-started)
34+
- [🔧 Usage](#-usage)
35+
- [🛠️ Technologies](#️-technologies-used)
36+
- [🤝 Contributing](#-contributing)
37+
38+
## ⚡ Quick Start
39+
40+
Want to jump right in? **[Try the live demo](https://www.codepatchwork.com)** - no installation needed!
41+
42+
For local development, you'll need Node.js 18+ and PostgreSQL. See detailed setup below ⬇️
43+
744
## ✨ Features
845

9-
- **Visual Organization**: Manage code snippets with a Pinterest-style visual interface
10-
- **Syntax Highlighting**: Automatic code highlighting for 100+ programming languages
11-
- **Powerful Search & Filtering**: Find snippets by language, tags, or full-text search
12-
- **Collections**: Organize snippets into custom collections for better categorization
13-
- **Tags & Metadata**: Add tags and descriptions to make snippets more discoverable
14-
- **Authentication**: Secure sign-in with Google OAuth or email/password
15-
- **Responsive Design**: Works on desktop, tablet, and mobile devices
16-
- **Sharing**: Share snippets publicly with customizable links
17-
- **Import/Export**: Easily backup or migrate your snippets
18-
- **Dark/Light Themes**: Choose your preferred visual theme for better readability
19-
- **Comment System**: Collaborate and discuss code with other users
46+
### 🎨 **Visual Experience**
47+
- **Pinterest-Style Interface** - Visually appealing snippet organization
48+
- **Syntax Highlighting** - Beautiful code display for 100+ languages
49+
- **Dark/Light Themes** - Customizable visual experience
50+
- **Responsive Design** - Perfect on desktop, tablet, and mobile
51+
52+
### 🔍 **Organization & Discovery**
53+
- **Smart Search & Filtering** - Find snippets by language, tags, or content
54+
- **Custom Collections** - Organize snippets into themed groups
55+
- **Tags & Metadata** - Rich categorization and discovery
56+
- **Import/Export** - Easy backup and migration
57+
58+
### 🤝 **Collaboration & Sharing**
59+
- **Public Sharing** - Share snippets with customizable links
60+
- **Comment System** - Collaborate and discuss code
61+
- **Secure Authentication** - Google OAuth or email/password
62+
63+
## 📸 Screenshots
64+
65+
![Main Interface](screenshots/main-interface.png)
66+
*Beautiful Pinterest-style code snippet organization*
67+
68+
![Dark Mode](screenshots/dark-mode.png)
69+
*Elegant dark theme for comfortable coding*
2070

2171
## 🚀 Getting Started
2272

@@ -154,6 +204,18 @@ Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for det
154204

155205
For questions or support, please open an issue on the GitHub repository.
156206

207+
## 🌟 **Ready to Transform Your Code Snippets?**
208+
209+
<div align="center">
210+
211+
### **[🚀 Try CodePatchwork Now](https://www.codepatchwork.com)**
212+
213+
[![Star this repo](https://img.shields.io/badge/⭐_Star_this_repo-black?style=for-the-badge&logo=github)](https://github.com/hexawulf/CodePatchwork)
214+
[![Report Bug](https://img.shields.io/badge/🐛_Report_Bug-red?style=for-the-badge)](https://github.com/hexawulf/CodePatchwork/issues)
215+
[![Request Feature](https://img.shields.io/badge/💡_Request_Feature-blue?style=for-the-badge)](https://github.com/hexawulf/CodePatchwork/issues)
216+
217+
</div>
218+
157219
---
158220

159221
Made with ❤️ by [hexawulf](https://github.com/hexawulf)

0 commit comments

Comments
 (0)