Skip to content

Commit 710fb40

Browse files
committed
docs(README): update project description, update shield links, and restructure table of contents for clarity
1 parent e756518 commit 710fb40

1 file changed

Lines changed: 82 additions & 36 deletions

File tree

README.md

Lines changed: 82 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
# LGamila Stream Platform
22

3-
![GitHub Issues or Pull Requests](https://img.shields.io/github/issues/stormix/lgamila)
4-
![CodeRabbit Pull Request Reviews](https://img.shields.io/coderabbit/prs/github/Stormix/lgamila?utm_source=oss&utm_medium=github&utm_campaign=Stormix%2Flgamila&labelColor=171717&color=FF570A&link=https%3A%2F%2Fcoderabbit.ai&label=CodeRabbit+Reviews)
5-
[![API Status](https://uptime.betterstack.com/status-badges/v1/monitor/22wjm.svg)](https://uptime.betterstack.com/?utm_source=status_badge)
6-
[![Web Status](https://uptime.betterstack.com/status-badges/v1/monitor/22wjk.svg)](https://uptime.betterstack.com/?utm_source=status_badge)
3+
![GitHub Issues or Pull Requests](https://img.shields.io/github/issues/lgamila/lgamila)
4+
![CodeRabbit Pull Request Reviews](https://img.shields.io/coderabbit/prs/github/lgamila/lgamila?utm_source=oss&utm_medium=github&utm_campaign=lgamila%2Flgamila&labelColor=171717&color=FF570A&link=https%3A%2F%2Fcoderabbit.ai&label=CodeRabbit+Reviews)
5+
[![API Status](https://uptime.betterstack.com/status-badges/v1/monitor/22wjm.svg)](https://status.lgamila.ma/)
6+
[![Web Status](https://uptime.betterstack.com/status-badges/v1/monitor/22wjk.svg)](https://status.lgamila.ma/)
77

88
<div align="center">
99

1010
![LGamila Logo](./apps/web/public/lgamila-live.svg)
1111

12-
### LGamila - Moroccan Streaming Platform
12+
### LGamila - Empowering Moroccan Streamers 🇲🇦
1313

14-
A comprehensive platform for discovering and tracking Moroccan streamers on Twitch and Kick, featuring a browser extension, web platform, and robust backend API.
14+
_By streamers, for streamers._ A community-driven platform built to empower Moroccan content creators and help them thrive in the streaming ecosystem. We're not just building tools—we're building a movement to elevate Moroccan talent worldwide.
1515

16-
[Download Extension](#browser-extension) · [Report Bug](https://github.com/stormix/lgamila/issues) · [Request Feature](https://github.com/stormix/lgamila/issues)
16+
[Download Extension](https://www.lgamila.ma/) · [Report Bug](https://github.com/lgamila/lgamila/issues) · [Request Feature](https://github.com/stormix/lgamila/issues)
1717

1818
</div>
1919

@@ -22,29 +22,48 @@ A comprehensive platform for discovering and tracking Moroccan streamers on Twit
2222
## Table of Contents
2323

2424
1. [About the Project](#about-the-project)
25-
2. [Screenshots](#screenshots)
26-
3. [What's Inside?](#whats-inside)
27-
4. [Getting Started](#getting-started)
25+
2. [Mission & Vision](#-mission--vision)
26+
3. [Screenshots](#screenshots)
27+
4. [What's Inside?](#whats-inside)
28+
5. [Getting Started](#getting-started)
2829
- [Prerequisites](#prerequisites)
2930
- [Installation](#installation)
30-
5. [Usage](#usage)
31-
6. [Releases](#releases)
32-
7. [Contributing](#contributing)
33-
8. [License](#license)
34-
9. [Contact](#contact)
35-
10. [Acknowledgments](#acknowledgments)
31+
6. [Usage](#usage)
32+
7. [Community Impact](#-community-impact)
33+
8. [Releases](#releases)
34+
9. [Contributing](#contributing)
35+
10. [License](#license)
36+
11. [Contact](#contact)
37+
12. [Acknowledgments](#acknowledgments)
3638

3739
## About the Project
3840

39-
LGamila is a platform dedicated to the Moroccan streaming community, providing tools to discover and follow Moroccan content creators across Twitch and Kick platforms. The project consists of a browser extension that shows real-time streaming status, a web platform for community engagement, and a robust backend API that tracks streamers across multiple platforms.
41+
LGamila started as a passion project by Moroccan streamers who wanted to see their community thrive. We recognized that talented Moroccan creators needed better visibility and tools to grow their audience, so we built a comprehensive ecosystem to address these challenges.
4042

41-
### Key Features
43+
**Our story:** Born from the vibrant Moroccan streaming community, LGamila is more than just a technical solution—it's a collective effort to build the infrastructure our creators deserve. We're streamers building for streamers, understanding the unique challenges and opportunities within our community.
4244

43-
- **Real-time Stream Tracking**: Monitor live status across Twitch and Kick
44-
- **Browser Extension**: Chrome extension showing live Moroccan streamers
45-
- **Web Platform**: Community-driven platform for discovering streamers
46-
- **Streamer Suggestions**: Community can suggest new streamers to add
47-
- **Cross-platform Support**: Unified view of streamers across multiple platforms
45+
## 🎯 Mission & Vision
46+
47+
**Mission:** To provide Moroccan streamers with world-class tools and community support, helping them gain the recognition they deserve and build sustainable streaming careers.
48+
49+
**Vision:** A future where every talented Moroccan streamer has the resources, visibility, and community support needed to thrive on the global stage.
50+
51+
### What Drives Us
52+
53+
- 🤝 **Community First**: Everything we build is designed with our community's needs at the forefront
54+
- 🛠️ **Innovation**: Creating cutting-edge tools that give Moroccan streamers a competitive advantage
55+
- 🌟 **Recognition**: Amplifying Moroccan talent and showcasing our creators to the world
56+
- 🚀 **Growth**: Providing the infrastructure for sustainable streaming careers
57+
58+
### 🚀 Community-Driven Features
59+
60+
- **🔴 Real-time Discovery**: Never miss when your favorite Moroccan streamers go live across Twitch and Kick
61+
- **📱 Browser Extension**: Instant access to live Moroccan streamers with desktop notifications
62+
- **🌐 Community Web Platform**: Discover new creators and connect with fellow community members
63+
- **🎯 Streamer Spotlight**: Community-powered suggestions to help talented creators gain visibility
64+
- **🔄 Multi-Platform Unity**: See all Moroccan streamers in one place, regardless of their platform
65+
- **📊 Growth Analytics**: _(Coming Soon)_ Help streamers understand and grow their audience
66+
- **🤝 Creator Networking**: _(Coming Soon)_ Connect Moroccan streamers for collaboration opportunities
4867

4968
## Screenshots
5069

@@ -156,19 +175,31 @@ The backend provides a REST API for accessing streamer data:
156175
2. Load the extension in your browser:
157176
- **Chrome**: Load from `apps/extension/build/chrome-mv3-prod`
158177
- **Firefox**: Load from `apps/extension/build/firefox-mv2-prod`
159-
3. The extension will show live Moroccan streamers in the popup
178+
3. Get instant notifications when Moroccan streamers go live and never miss your favorite creators
160179

161-
#### Download Pre-built Extension
180+
#### Download Extension
162181

163-
You can also download pre-built extension files from our [GitHub Releases](https://github.com/stormix/lgamila/releases).
182+
Visit our website at [lgamila.ma](https://www.lgamila.ma/) to download the extension for your browser with easy installation instructions.
164183

165184
### Web Platform
166185

167-
Visit the web platform to:
186+
Visit [lgamila.ma](https://www.lgamila.ma/) to:
187+
188+
- **Discover** talented Moroccan streamers across all platforms
189+
- **Support** creators by suggesting new streamers to feature
190+
- **Connect** with our growing community of streamers and viewers
191+
- **Learn** about our mission to empower Moroccan creators
192+
193+
## 📈 Community Impact
168194

169-
- Discover new Moroccan streamers
170-
- Suggest streamers to be added to the platform
171-
- Learn about the project
195+
Since launching, LGamila has been making a tangible impact on the Moroccan streaming community:
196+
197+
- **Growing Network**: Connecting streamers and viewers across Morocco and the diaspora
198+
- **Increased Visibility**: Helping talented creators gain recognition they deserve
199+
- **Cross-Platform Discovery**: Unifying the fragmented streaming landscape for Moroccan content
200+
- **Community Collaboration**: Fostering connections between creators for mutual growth
201+
202+
_Want to be part of our growing community? [Download the extension](https://www.lgamila.ma/) or [suggest a streamer](https://www.lgamila.ma/suggest) today!_
172203

173204
## Releases
174205

@@ -179,7 +210,7 @@ Extension releases are automatically built and published via GitHub Actions. Eac
179210

180211
### Download Latest Release
181212

182-
Visit our [GitHub Releases page](https://github.com/stormix/lgamila/releases) to download the latest extension builds.
213+
Visit [lgamila.ma](https://www.lgamila.ma/) to download the latest extension builds with easy installation for Chrome, Firefox, and other browsers.
183214

184215
### Creating Releases
185216

@@ -219,12 +250,19 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
219250

220251
**Project Link**: [https://github.com/stormix/lgamila](https://github.com/stormix/lgamila)
221252

222-
## Acknowledgments
253+
## 🙏 Acknowledgments
254+
255+
LGamila exists because of the incredible Moroccan streaming community and the open source ecosystem that powers our tools. Special recognition goes to:
256+
257+
### 🇲🇦 Community Heroes
223258

224-
This project was made possible thanks to the amazing open source community and the Moroccan streaming community, especially:
259+
- [Zikoos Jam](https://www.twitch.tv/zikoos_jam) - Original inspiration and the spark that started this journey
260+
- [EKB9816](https://x.com/ekb9816) - Our talented designer who created our beautiful logo and branding
261+
- **Every Moroccan streamer** featured on our platform - You make our community vibrant and inspiring
262+
- **The contributors and supporters** who help us grow and improve every day
263+
264+
### 🛠️ Technology Partners
225265

226-
- [Zikoos Jam](https://www.twitch.tv/zikoos_jam) - Original project inspiration
227-
- [EKB9816](https://x.com/ekb9816) - Project designer and logo creator
228266
- [Hono](https://hono.dev/) - Fast web framework
229267
- [Astro](https://astro.build/) - Modern web framework
230268
- [Plasmo](https://docs.plasmo.com/) - Browser extension framework
@@ -238,5 +276,13 @@ This project was made possible thanks to the amazing open source community and t
238276
---
239277

240278
<p align="center">
241-
Made with ❤️ by the Moroccan Streaming Community
279+
<strong>🇲🇦 Built by streamers, for streamers</strong><br/>
280+
Made with ❤️ by the Moroccan Streaming Community<br/>
281+
<em>Empowering creators, one stream at a time</em>
282+
</p>
283+
284+
<p align="center">
285+
<a href="https://www.lgamila.ma/">🌐 Visit Our Platform</a> •
286+
<a href="https://www.lgamila.ma/">📱 Download Extension</a> •
287+
<a href="https://www.lgamila.ma/suggest">🎯 Suggest a Streamer</a>
242288
</p>

0 commit comments

Comments
 (0)