From a6b238c86294f5bef17abc19003b0aca076a84a4 Mon Sep 17 00:00:00 2001
From: bartromb <bart.rombaut@gmail.com>
Date: Sat, 11 Jan 2025 15:05:46 +0100
Subject: [PATCH] Add YASA Flaskified details to README and FAQ

---
 README.rst   |  9 +++++++++
 docs/faq.rst | 33 +++++++++++++++++++++++++++++++++
 2 files changed, 42 insertions(+)

diff --git a/README.rst b/README.rst
index c4fa2c21..44cfbe5b 100644
--- a/README.rst
+++ b/README.rst
@@ -144,3 +144,12 @@ Citation
 To cite YASA, please use the `eLife publication <https://elifesciences.org/articles/70092>`_:
 
 * Vallat, Raphael, and Matthew P. Walker. "An open-source, high-performance tool for automated sleep staging." Elife 10 (2021). doi: https://doi.org/10.7554/eLife.70092
+
+Related Projects
+~~~~~~~~~~~~~~~~~
+
+Looking for a web-based solution to utilize YASA? Check out **YASA Flaskified**: a Flask-based application designed to process and analyze EEG data via an intuitive web interface. 
+
+**YASA Flaskified** also supports straightforward deployment on your own physical or virtual server using a preconfigured deployment script. 
+
+Repository: `YASA Flaskified <https://github.com/bartromb/YASAFlaskified>`_
diff --git a/docs/faq.rst b/docs/faq.rst
index adf089ee..d1b460eb 100644
--- a/docs/faq.rst
+++ b/docs/faq.rst
@@ -324,6 +324,39 @@ Whenever a new release is out there, you can upgrade your version by typing the
 .. code-block:: shell
 
     pip install --upgrade yasa
+    
+
+.. ----------------------------- RELATED PROJECTS -----------------------------
+.. raw:: html
+
+    <div class="panel panel-default">
+      <div class="panel-heading">
+        <h5 class="panel-title">
+          <a data-toggle="collapse" href="#related_projects">Are there any related projects?</a>
+        </h5>
+      </div>
+      <div id="related_projects" class="panel-collapse collapse">
+        <div class="panel-body">
+
+**YASA Flaskified**
+
+YASA Flaskified is a Flask-based web application that provides an intuitive interface for analyzing EEG data using the YASA library. It allows users to perform sleep analysis directly from their browser, simplifying workflows for those unfamiliar with Python or command-line tools.
+
+**Features of YASA Flaskified:**
+
+- **Web-based Interface:** YASA Flaskified transforms YASA's functionality into an accessible web application, enabling sleep analysis without direct Python programming.
+- **Deployment Options:** Users can deploy YASA Flaskified on their own physical or virtual server using a preconfigured deployment script. This allows for private, secure, and scalable use of the application.
+- **Integration with YASA:** The application is built around the YASA library, ensuring full compatibility and access to its core features, including sleep staging, event detection, and more.
+
+**Where to find it?**
+
+YASA Flaskified is available on GitHub: 
+`YASA Flaskified <https://github.com/bartromb/YASAFlaskified>`_
+
+        </div>
+      </div>
+    </div>
+
 
 .. ----------------------------- DONATION -----------------------------
 .. raw:: html