Skip to content

Commit 79a42c6

Browse files
KxffieKxffie
authored
Update README.md
1 parent a695f21 commit 79a42c6

File tree

1 file changed

+104
-72
lines changed

1 file changed

+104
-72
lines changed

‎README.md

Lines changed: 104 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# 🚀 SnipIt - Code Snippet Manager
22

33
<p align="center">
4-
<img src="https://github.com/user-attachments/assets/4fbeb719-3a74-43e0-844d-ca4637a10c47" width="500" alt="SnipIt Logo">
4+
<img src="https://github.com/user-attachments/assets/4fbeb719-3a74-43e0-844d-ca4637a10c47" width="750" alt="SnipIt Logo">
55
</p>
66

77
<p align="center">
@@ -30,104 +30,136 @@
3030

3131
---
3232

33-
## 🚀 Features
33+
<h2>🚀 Features</h2>
3434

35-
- **Offline-first**: Works locally for instant access.
36-
- **Tagging System**: Organize snippets by language, project type, and custom tags.
37-
- **GitHub Backup**: Sync snippets to a public or private GitHub repository. (Planned)
38-
- **Fast Search**: Quickly find stored snippets with keyword and tag filtering.
35+
<ul>
36+
<li>✅ <strong>Offline-first</strong> – Works locally for instant access.</li>
37+
<li>🏷️ <strong>Tagging System</strong> – Organize snippets by language, project type, and custom tags.</li>
38+
<li>☁️ <strong>GitHub Backup</strong> – Sync snippets to a public or private GitHub repository. <em>(Planned)</em></li>
39+
<li>🔍 <strong>Fast Search</strong> – Quickly find stored snippets with keyword and tag filtering.</li>
40+
</ul>
3941

4042
---
4143

42-
## 📦 Installation
43-
44-
### Download SnipIt
45-
You can install SnipIt in three ways:
46-
47-
1. **Website Download:**
48-
- Visit [SnipIt Official Website](https://google.com) and download the latest version. (Coming Soon)
49-
50-
2. **GitHub Releases:**
51-
- On the right side of this GitHub repository, under "Releases," download the latest version for your OS.
52-
53-
3. **Manual Installation (For Developers):**
54-
- **Clone the repository:**
55-
```sh
56-
git clone https://github.com/yourusername/snipit.git
57-
cd snipit
58-
```
59-
- **Install dependencies:**
60-
```sh
61-
# Using npm
62-
npm install
63-
64-
# OR using yarn
65-
yarn install
66-
```
67-
- **Run in development mode:**
68-
```sh
69-
# Using npm
70-
npm run tauri dev
71-
72-
# OR using yarn
73-
yarn tauri dev
74-
```
75-
- **Build the application:**
76-
```sh
77-
# Using npm
78-
npm run tauri build
79-
80-
# OR using yarn
81-
yarn tauri build
82-
```
44+
<h2>📦 Installation</h2>
45+
46+
<h3>🔽 Download SnipIt</h3>
47+
48+
<ul>
49+
<li><strong>Website Download</strong> (<em>Coming Soon!</em>)
50+
<br>Visit <a href="https://google.com">SnipIt Official Website</a> and download the latest version.</li>
51+
<li><strong>GitHub Releases</strong>
52+
<br>Go to the <a href="https://github.com/yourusername/snipit/releases">Releases</a> section and download the latest version for your OS.</li>
53+
</ul>
54+
55+
<h3>🛠️ Manual Installation (For Developers)</h3>
56+
57+
<ol>
58+
<li><strong>Clone the repository:</strong></li>
59+
60+
<pre>
61+
git clone https://github.com/kxffie/snipit.git
62+
cd snipit
63+
</pre>
64+
65+
<li><strong>Install dependencies:</strong></li>
66+
67+
<pre>
68+
# Using npm
69+
npm install
70+
71+
# OR using yarn
72+
yarn install
73+
</pre>
74+
75+
<li><strong>Run in development mode:</strong></li>
76+
77+
<pre>
78+
# Using npm
79+
npm run tauri dev
80+
81+
# OR using yarn
82+
yarn tauri dev
83+
</pre>
84+
85+
<li><strong>Build the application:</strong></li>
86+
87+
<pre>
88+
# Using npm
89+
npm run tauri build
90+
91+
# OR using yarn
92+
yarn tauri build
93+
</pre>
94+
</ol>
8395

8496
---
8597

86-
## 📖 Usage
98+
<h2>📖 Usage</h2>
8799

88-
1. **Add a snippet**: Paste your reusable code and tag it for easy retrieval.
89-
2. **Search**: Use keywords or filters to find saved snippets.
90-
3. **Copy & Use**: Click to copy and insert it into your project as fast as your hands can go.
100+
<ul>
101+
<li>📌 <strong>Add a snippet</strong> – Paste your reusable code and tag it for easy retrieval.</li>
102+
<li>📌 <strong>Search</strong> – Use keywords or filters to find saved snippets.</li>
103+
<li>📌 <strong>Copy & Use</strong> – Click to copy and insert it into your project instantly.</li>
104+
</ul>
91105

92106
---
93107

94-
## 🤝 Contributing
108+
<h2>🤝 Contributing</h2>
95109

96-
I welcome contributions! To contribute:
110+
<p>SnipIt is open to contributions! If you'd like to contribute:</p>
97111

98-
1. Fork the repository.
99-
2. Create a new branch (`git checkout -b feature-name`).
100-
3. Make your changes and commit (`git commit -m 'Added feature'`).
101-
4. Push to your fork (`git push origin feature-name`).
102-
5. Open a pull request.
112+
<ol>
113+
<li><strong>Fork</strong> the repository.</li>
114+
<li><strong>Create a new branch:</strong></li>
103115

104-
---
116+
<pre>
117+
git checkout -b feature-name
118+
</pre>
119+
120+
<li><strong>Make your changes and commit:</strong></li>
105121

106-
## 🛠 Tech Stack
122+
<pre>
123+
git commit -m "Added feature"
124+
</pre>
107125

108-
- **Frontend**: Vite + React + Typescript
109-
- **Backend**: Tauri (Rust)
110-
- **UI Components**: ShadCN, Lucide Icons
126+
<li><strong>Push to your fork:</strong></li>
127+
128+
<pre>
129+
git push origin feature-name
130+
</pre>
131+
132+
<li><strong>Open a pull request</strong> on GitHub.</li>
133+
</ol>
111134

112135
---
113136

114-
## 📜 License
137+
<h2>🛠 Tech Stack</h2>
115138

116-
This project is licensed under the **MIT License**. See the [LICENSE](LICENSE) file for details.
139+
<ul>
140+
<li>🖥️ <strong>Frontend</strong>: Vite + React + TypeScript</li>
141+
<li>⚙️ <strong>Backend</strong>: Tauri (Rust)</li>
142+
<li>🎨 <strong>UI Components</strong>: ShadCN, Lucide Icons</li>
143+
</ul>
117144

118145
---
119146

120-
## 🌟 Support
147+
<h2>📜 License</h2>
121148

122-
If you find this project helpful, please ⭐ the repo! Have feedback? Open an issue or join the discussion.
149+
<p>This project is licensed under the <strong>MIT License</strong>. See the <a href="LICENSE">LICENSE</a> file for details.</p>
123150

124151
---
125152

126-
## 📩 Contact
153+
<h2>🌟 Support</h2>
127154

128-
For questions or suggestions, reach out via:
129-
- **Discord Server**: [SnipIt Discord](https://discord.gg/srPwBXVF)
130-
- **Discord**: kxffie
131-
- **Twitter**: [@kxffie](https://x.com/kxffie)
155+
<p>If you find this project helpful, please ⭐ the repo! Have feedback? Open an issue or join the discussion.</p>
132156

133157
---
158+
159+
<h2>📩 Contact</h2>
160+
161+
<ul>
162+
<li>💬 <strong>Discord Server</strong>: <a href="https://discord.gg/srPwBXVF">SnipIt Discord</a></li>
163+
<li>📩 <strong>Discord</strong>: kxffie</li>
164+
<li>🐦 <strong>Twitter</strong>: <a href="https://x.com/kxffie">@kxffie</a></li>
165+
</ul>

0 commit comments

Comments
 (0)