Skip to content

Commit

Permalink
add flow diagram
Browse files Browse the repository at this point in the history
  • Loading branch information
SonOfLope committed Jun 20, 2024
1 parent cf26e74 commit 45582e7
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,30 @@ point-virgule est un bot Discord conçu pour rejoindre des canaux vocaux, enregi
l'audio et l'envoyer a un service de transcription automatique.

Séquence de fonctionnement:
![point-virgule](./img/sequence-diagram.png)

```mermaid
sequenceDiagram
participant User
participant Discord
participant Point-Virgule
participant Point
participant Virgule
User->>Discord: User starts voice channel
User->>Discord: /start_meeting channel_id
Discord->>Point-Virgule: Joins voice channel
Point-Virgule->>Discord: Recording started
Discord->>User: acknowledgment of recording started
User->>Discord: /stop_meeting
Discord->>Point-Virgule: Recording stopped
Point-Virgule->>Discord: Leave voice channel
Point-Virgule->>Point: Send audio data
Point->>Point-Virgule: Send back transcription
Point-Virgule->>Virgule: Send transcription
Virgule->>Point-Virgule: Sends back summary
Point-Virgule->>Discord: Send summary
Discord->>User: Send summary
```

## Prérequis

Expand Down
Binary file removed img/sequence-diagram.png
Binary file not shown.

0 comments on commit 45582e7

Please sign in to comment.