Skip to content

Commit 5b6a354

Browse files
authored
Update README.md
1 parent c5bc7d0 commit 5b6a354

File tree

1 file changed

+47
-57
lines changed

1 file changed

+47
-57
lines changed

README.md

Lines changed: 47 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,56 @@
11
# Code Gems
2-
32
![Code Gems Thumbnail](/data/image.png)
4-
53
<div align="center">
6-
<a href="https://www.buymeacoffee.com/bebedi">
7-
<img src="https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&emoji=☕&slug=bebedi&button_colour=FFDD00&font_colour=000000&font_family=Poppins&outline_colour=000000&coffee_colour=ffffff" width="200" />
8-
</a>
4+
<a href="https://www.buymeacoffee.com/bebedi">
5+
<img src="https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&emoji=☕&slug=bebedi&button_colour=FFDD00&font_colour=000000&font_family=Poppins&outline_colour=000000&coffee_colour=ffffff" width="200" />
6+
</a>
97
</div>
108

11-
Welcome to **[Code Gems](https://codegems.xyz)**! This platform helps you discover and collect remarkable GitHub projects. Whether you're a developer, designer, or tech enthusiast, Code Gems is the ultimate resource for exploring outstanding open-source projects.
12-
13-
The website is currently in development and relies on YOUR input to grow! We’re looking for great project suggestions to feature. Feel free to submit your ideas through a [Request](https://codegems.xyz/request).
14-
15-
## Features
16-
17-
- **Search**: Easily find projects by name, description, or tags.
18-
- **Categorized Listings**: Projects are organized into categories such as AI, productivity, design, and more.
19-
- **Save for Later**: Bookmark projects to revisit your favorites anytime.
20-
- **User-friendly Design**: A clean, visually appealing UI for seamless navigation.
21-
- **Requests**: Possibility to submit a GitHub project you think would make an excellent addition to the website.
22-
23-
## How It Works
24-
25-
1. **Browse**: Explore trending and curated GitHub projects.
26-
2. **Search**: Use the search bar to find projects based on keywords or tags.
27-
3. **Save**: Bookmark projects you like for future reference.
28-
4. **Contribute**: Click on any project to visit its GitHub repository and contribute or learn more.
29-
5. **Requests**: Request a GitHub project you believe would be a great addition to the website.
30-
31-
## Installation
32-
33-
If you'd like to contribute to the Code Gems project or run it locally:
34-
35-
1. Clone the repository:
36-
```bash
37-
git clone https://github.com/bebedi15/codegems.git
38-
```
39-
2. Navigate to the project directory:
40-
```bash
41-
cd codegems
42-
```
43-
3. Install dependencies:
44-
```bash
45-
npm install
46-
```
47-
4. Start the development server:
48-
```bash
49-
npm run dev
50-
```
51-
52-
## Contributing
53-
54-
We welcome contributions from the community! If you have ideas or bug fixes, feel free to submit a pull request or open an issue.
55-
56-
## License
57-
9+
Welcome to **[Code Gems](https://codegems.xyz)** - a community-driven platform for discovering and sharing remarkable GitHub projects! The heart of Code Gems is YOU - developers, designers, and tech enthusiasts who know about amazing open-source projects that deserve more visibility.
10+
11+
## 🌟 Share Your Discoveries
12+
Found an impressive project? Built something cool? We want to feature it! You can:
13+
- Submit your own projects
14+
- Suggest great open-source work you've discovered
15+
- Share projects that helped you in your development journey
16+
17+
Submit your suggestions through our [Request](https://codegems.xyz/request) page.
18+
19+
## 🔍 Platform Features
20+
- Community-curated project collections
21+
- Search by name, description, or tags
22+
- Category-based browsing (AI, productivity, design, etc.)
23+
- Project bookmarking for later reference
24+
- Clean, intuitive interface
25+
26+
## 🚀 Getting Started
27+
1. **Explore**: Browse through community-suggested projects
28+
2. **Submit**: Share projects you think others should know about
29+
3. **Search**: Find specific tools using tags or keywords
30+
4. **Save**: Bookmark projects for future reference
31+
5. **Contribute**: Visit GitHub repositories to learn more or contribute
32+
33+
## 💻 Local Development
34+
```bash
35+
git clone https://github.com/bebedi15/codegems.git
36+
cd codegems
37+
npm install
38+
npm run dev
39+
```
40+
41+
## 🤝 Contributing
42+
We welcome all types of contributions:
43+
44+
- [Project submissions](https://codegems.xyz/request)
45+
- [Feature suggestions](https://github.com/bebedi15/codegems/issues/new/choose)
46+
- [Bug reports and fixes](https://github.com/bebedi15/codegems/issues/new/choose)
47+
- [UI/UX improvements](https://github.com/bebedi15/codegems/pulls)
48+
49+
Open an issue or submit a pull request to get started.
50+
51+
## 📄 License
5852
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
5953

60-
## Feedback
61-
62-
We value your feedback! If you have suggestions, feel free to reach out or open an issue.
63-
6454
---
6555

66-
Happy exploring with **[Code Gems](https://codegems.xyz)**!
56+
Join us in building the ultimate resource for discovering GitHub gems at Code Gems!

0 commit comments

Comments
 (0)