From 062b2bc42bab833b64b2bfd9edad980baf535b9b Mon Sep 17 00:00:00 2001
From: Avnyr <avnyr@yidhra.fr>
Date: Sat, 3 Jan 2026 16:22:53 +0100
Subject: [PATCH] Update README with detailed project overview and resources

---
 README.md | 93 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 92 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 7ceb758..a4132bb 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,93 @@
-# memegoat
+<h3 align="center">
+  <a name="readme-top"></a>
+  <img
+    src="https://git.yidhra.fr/repo-avatars/a65bdb0b2864a481aeb7ae2f21201938a25eda4dd36775163a21dc613dd7347c"
+    height="200"
+  >
+</h3>
+<div align="center">
+    <a href="https://git.yidhra.fr/Mathis/memegoat/src/branch/dev/LICENSE">
+  <img src="https://img.shields.io/badge/License-AGPL3.0-green" alt="License">
+<a href="https://git.yidhra.fr/Mathis/memegoat/commits">
+    <img src="https://img.shields.io/badge/Status-Ongoing-blue" alt="Commits">
+  </a>
+<a href="https://memegoat.fr?ref=git">
+  <img src="https://img.shields.io/badge/Visit-memegoat.fr-orange" alt="Visit memegoat.fr">
+</a>
+</div>
+<div>
+  <p align="center">
+    <a href="#">
+      <img src="https://img.shields.io/badge/Follow%20me%20on%20LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white" alt="Follow on LinkedIn" />
+    </a>
+    <a href="#">
+      <img src="https://img.shields.io/badge/Join%20my%20Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white" alt="Join our Discord" />
+    </a>
+  </p>
+</div>
 
+# 🐐 Memegoat
+
+Lorem ipsum dolor sit amet
+
+_This repository is in development, and we’re still integrating core feature into the mono repo. It's not fully ready for self-hosted deployment yet, but you can run it locally._
+
+## What is Memegoat ?
+
+[Firecrawl](https://memegoat.fr?ref=git) Lorem ipsum dolor sit amet. Check out our [documentation](https://docs.memegoat.fr).
+
+Lorem ipsum dolor sit amet
+
+_Pst. hey, you, join our stargazers :)_
+
+## How to use it?
+
+Lorem ipsum dolor sit amet. You can also self host if you'd like.
+
+Check out the following resources to get started:
+- **API**: [Documentation](#)
+- **Data Model**: [MLD/LDM](#), [MCD/CDM](#), [MPD/PDM](#)
+- **Technical choices**: [The stack](#), [Security choices](#), [Docker](#)
+
+To run locally, refer to guide [here](#).
+
+### API Key
+
+To use the API, you need to sign up on [Memegoat](https://memegoat.fr) and get an API key.
+
+### Features
+
+- [**Blank**](#anchor): lorem ipsum
+
+### Powerful Capabilities
+- **The hard stuff**: proxies, anti-bot mechanisms, dynamic content (js-rendered), output parsing, orchestration
+- 
+### anchor
+
+lorem ipsum
+
+## Contributing
+
+We love contributions! Please read our [contributing guide](CONTRIBUTING.md) before submitting a pull request. If you'd like to self-host, refer to the [self-hosting guide](SELF_HOST.md).
+
+_It is the sole responsibility of the end users to respect websites' policies when scraping, searching and crawling with Firecrawl. Users are advised to adhere to the applicable privacy policies and terms of use of the websites prior to initiating any scraping activities. By default, Firecrawl respects the directives specified in the websites' robots.txt files when crawling. By utilizing Firecrawl, you expressly agree to comply with these conditions._
+
+
+## License Disclaimer
+
+This project is primarily licensed under the GNU Affero General Public License v3.0 (AGPL-3.0), as specified in the LICENSE file in the root directory of this repository. However, certain components of this project are licensed under the MIT License. Refer to the LICENSE files in these specific directories for details.
+
+Please note:
+
+- The AGPL-3.0 license applies to all parts of the project unless otherwise specified.
+- The SDKs and some UI components are licensed under the MIT License. Refer to the LICENSE files in these specific directories for details.
+- When using or contributing to this project, ensure you comply with the appropriate license terms for the specific component you are working with.
+
+For more details on the licensing of specific components, please refer to the LICENSE files in the respective directories or contact the project maintainers.
+
+
+<p align="right" style="font-size: 14px; color: #555; margin-top: 20px;">
+    <a href="#readme-top" style="text-decoration: none; color: #007bff; font-weight: bold;">
+        ↑ Back to Top ↑
+    </a>
+</p>
\ No newline at end of file