Skip to content

Commit dcf9fc2

Browse files
committed
Update README
1 parent 5eb2af0 commit dcf9fc2

File tree

2 files changed

+31
-186
lines changed

2 files changed

+31
-186
lines changed

README.md

Lines changed: 31 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -4,37 +4,33 @@
44

55
> A powerful Discord bot for collecting and analyzing message statistics and insights for your guilds.
66
7-
## Data Flow
8-
9-
```mermaid
10-
graph LR
11-
A[Discord Messages] -->|Collected| B[Abeille Bot]
12-
B -->|Pseudonymized| C[SQLite Database]
13-
C -->|Analyzed| D[Statistics & Insights]
14-
D -->|Presented| E[Discord Commands]
15-
B -->|Handles| E
16-
```
17-
187
## 📋 Table of Contents
198

20-
- [Overview](#overview)
21-
- [Features](#features)
22-
- [Dependencies](#dependencies)
23-
- [Run Your Own Abeille](#run-your-own-abeille)
24-
- [Setting Up](#setting-up)
25-
- [Environment Variables](#environment-variables)
26-
- [Run](#run)
27-
- [Development](#development)
28-
- [Commands](#commands)
29-
- [Contributing](#contributing)
30-
- [Documentation](#documentation)
9+
- [Abeille 🐝](#abeille-)
10+
- [📋 Table of Contents](#-table-of-contents)
11+
- [Overview](#overview)
12+
- [Features](#features)
13+
- [Dependencies](#dependencies)
14+
- [Run Your Own Abeille](#run-your-own-abeille)
15+
- [Setting Up](#setting-up)
16+
- [Environment Variables](#environment-variables)
17+
- [Run](#run)
18+
- [Development](#development)
19+
- [Commands](#commands)
20+
- [Activity Commands](#activity-commands)
21+
- [Message Commands](#message-commands)
22+
- [Admin Commands](#admin-commands)
23+
- [Privacy Commands](#privacy-commands)
24+
- [Developer Commands (_may be removed in the future_)](#developer-commands-may-be-removed-in-the-future)
25+
- [Utility Commands](#utility-commands)
26+
- [Contributing](#contributing)
27+
- [Documentation](#documentation)
28+
- [Data Flow](#data-flow)
3129

3230
## Overview
3331

3432
Abeille is a Discord bot providing statistics and insights for guilds. It maintains a database (one for each guild) with the messages from each connected guild, in order to perform efficient and various search operations (since Discord does not provide any API to perform search operations).
3533

36-
> **Note**: For now, there is no public Abeille bot. You should run your own Abeille bot instance by following the steps below.
37-
3834
## Features
3935

4036
- Saves messages from tracked guilds while using pseudonymization.
@@ -62,7 +58,7 @@ Abeille is built using the following open source libraries:
6258

6359
## Run Your Own Abeille
6460

65-
Abeille is not (yet) a public Discord bot. You can run your own instance of Abeille by following these steps:
61+
You can run your own instance of Abeille by following these steps:
6662

6763
### Setting Up
6864

@@ -163,4 +159,13 @@ For more detailed information about Abeille, please see the following documentat
163159
- [Architecture Overview](docs/ARCHITECTURE.md) - Learn about Abeille's internal structure
164160
- [Security Best Practices](docs/SECURITY.md) - Important security recommendations
165161

166-
For developers interested in the database structure, see the [SaveScenarios.drawio](docs/SaveScenarios.drawio) diagram.
162+
## Data Flow
163+
164+
```mermaid
165+
graph LR
166+
A[Discord Messages] -->|Collected| B[Abeille Bot]
167+
B -->|Pseudonymized| C[SQLite Database]
168+
C -->|Analyzed| D[Statistics & Insights]
169+
D -->|Presented| E[Discord Commands]
170+
B -->|Handles| E
171+
```

docs/SaveScenarios.drawio

Lines changed: 0 additions & 160 deletions
This file was deleted.

0 commit comments

Comments
 (0)