From 5e826e1b3b97a793514e03847fb3ff45085f5943 Mon Sep 17 00:00:00 2001
From: dabico <dabico@usi.ch>
Date: Mon, 10 Jun 2024 15:01:15 +0200
Subject: [PATCH] Update README.md

---
 README.md | 50 ++++++++++++++++++++++----------------------------
 1 file changed, 22 insertions(+), 28 deletions(-)

diff --git a/README.md b/README.md
index e5c56654..7e6d3cb1 100644
--- a/README.md
+++ b/README.md
@@ -1,35 +1,20 @@
-<p align="center">
-  <a href="https://seart-dl4se.si.usi.ch/" target="_blank" rel="noopener noreferrer">
-    <img src="dl4se-website/src/assets/img/logo.png" alt="DL4SE Logo">
-  </a>
-</p>
-<p align="center">
-    <a href="https://github.com/seart-group/DL4SE/actions/workflows/maven-build.yml"><img src="https://github.com/seart-group/DL4SE/actions/workflows/maven-build.yml/badge.svg" alt="Maven Build Status"></a>
-    <a href="https://github.com/seart-group/DL4SE/actions/workflows/vue-build.yml"><img src="https://github.com/seart-group/DL4SE/actions/workflows/vue-build.yml/badge.svg" alt="Vue Build Status"></a>
-</p>
+# SEART Data Hub
 
-# DL4SE
-
-The DL4SE tool allows to easily create large-scale datasets that can be used to either run MSR studies or to train DL
-models to automate SE tasks.
+The SEART Data Hub platform allows to easily create large-scale datasets that can be used to either run empirical MSR
+studies or to train Deep Learning models to automate software engineering tasks.
 
 ## Contents
 
 This project contains several modules:
 
-- `dl4se-model`:
-A module containing domain model classes used for mapping the relational database structure to the programming
-- environment;
-- `dl4se-crawler`:
-A standalone crawler application that we use to mine Java source code from GitHub repositories indexed by
-[GitHub Search](https://seart-ghs.si.usi.ch/);
-- `dl4se-src2abs`:
-A modification of Michele Tufano's [src2abs](https://github.com/micheletufano/src2abs), changed for more convenient
-integration into the overall platform;
-- `dl4se-server`:
-A Spring Boot server application that acts as our platform back-end;
-- `dl4se-website`:
-A front-end web-application written in Vue.
+- `dl4se-model`: A module containing domain model classes used for mapping the relational database structure to the
+  programming environment;
+- `dl4se-analyzer`: A module containing implementations of code analysis operations running on `tree-sitter`;
+- `dl4se-crawler`: A standalone crawler application that we use to mine source code from GitHub repositories indexed by
+  [GitHub Search](https://seart-ghs.si.usi.ch/);
+- `dl4se-server`: A Spring Boot server application that acts as our platform back-end;
+- `dl4se-spring`: Common Spring Boot configuration and utilities used in both the server and the crawler;
+- `dl4se-website`: A front-end web-application written in Vue.
 
 ## Installation and Usage
 
@@ -49,6 +34,15 @@ This section will detail the necessary actions for setting up and running the pr
 
 ## FAQ
 
-### How can I report a bug, request a feature, or ask a question?
+### How can I request a feature or ask a question?
+
+If you have ideas for a feature you would like to see implemented or if you have any questions, we encourage you to
+create a new [discussion](https://github.com/seart-group/DL4SE/discussions/). By initiating a discussion, you can engage
+with the community and our team, and we'll respond promptly to address your queries or consider your feature requests.
+
+### How can I report a bug?
 
-Please add a [new issue](https://github.com/seart-group/DL4SE/issues) and we will get back to you very soon.
\ No newline at end of file
+To report any issues or bugs you encounter, please create a [new issue](https://github.com/seart-group/DL4SE/issues/).
+Providing detailed information about the problem you're facing will help us understand and address it more effectively.
+Rest assured, we are committed to promptly reviewing and responding to the issues you raise, working collaboratively
+to resolve any bugs and improve the overall user experience.