Skip to content

Commit

Permalink
docs: update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lambiengcode committed Apr 9, 2024
1 parent edb3005 commit 3dbc6df
Show file tree
Hide file tree
Showing 7 changed files with 30 additions and 24 deletions.
54 changes: 30 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,31 +14,37 @@

## Table of Contents
- [Table of Contents](#table-of-contents)
- [Introduction](#introduction)
- [Meeting Flow](#meeting-flow)
- [Entity Relationship Diagram (ERD)](#entity-relationship-diagram-erd)
- [Features](#features)
- [Quick run](#quick-run)
- [Requirements](#requirements)
- [Roadmap](#roadmap)
- [Links:](#links)

## Introduction
- [👋 Introduction](#-introduction)
- [👷 Meeting Flow](#-meeting-flow)
- [🛠️ Arch Design](#️-arch-design)
- [🧰 Entity Relationship Diagram (ERD)](#-entity-relationship-diagram-erd)
- [✨ Features](#-features)
- [🚀 Quick run](#-quick-run)
- [👇 Requirements](#-requirements)
- [🚏 Roadmap](#-roadmap)
- [Links](#links)

## 👋 Introduction

- 🤙 Waterbus is open source video conferencing multiplatform app built on latest WebRTC SDK. This is server api for the application.
- 🎯 Waterbus aims for scalability and low latency as well as self-hosted and offers many useful features for everyday interviews or meetings.

### Meeting Flow
### 👷 Meeting Flow

[![Sequence Diagram](./images/waterbus-flow-dark.gif)](https://docs.waterbus.tech#gh-dark-mode-only)
[![Sequence Diagram](./images/waterbus-flow-light.gif)](https://docs.waterbus.tech#gh-light-mode-only)

### 🛠️ Arch Design

[![Flow Diagram](./images/waterbus-flow-dark.gif)](https://docs.waterbus.tech#gh-dark-mode-only)
[![Flow Diagram](./images/waterbus-flow-light.gif)](https://docs.waterbus.tech#gh-light-mode-only)
[![Arch](./images/arch-high-level-design-dark.gif)](https://docs.waterbus.tech#gh-dark-mode-only)
[![Arch](./images/arch-high-level-design-light.gif)](https://docs.waterbus.tech#gh-light-mode-only)

### Entity Relationship Diagram (ERD)
### 🧰 Entity Relationship Diagram (ERD)

[![ERD](./images/waterbus-erd-dark.png)](https://docs.waterbus.tech#gh-dark-mode-only)
[![ERD](./images/waterbus-erd-light.png)](https://docs.waterbus.tech#gh-light-mode-only)

### Features
### Features

- [x] Login with Google
- [x] Refresh Token
Expand Down Expand Up @@ -68,9 +74,9 @@
- [x] Delete message
- [x] Delete conversations

## Quick run
## 🚀 Quick run

### Requirements
### 👇 Requirements

Before getting started, ensure you have the following software installed:

Expand Down Expand Up @@ -103,17 +109,17 @@ yarn
yarn start
```

## Roadmap
## 🚏 Roadmap

<div align="center">
<img src="./images/waterbus-roadmap-light.gif#gh-light-mode-only" width=50%/>
<img src="./images/waterbus-roadmap-dark.gif#gh-dark-mode-only" width=50%/>
<img src="./images/waterbus-roadmap-light.png#gh-light-mode-only" width=50%/>
<img src="./images/waterbus-roadmap-dark.png#gh-dark-mode-only" width=50%/>
</div>

## Links:
## Links

- Check document at [docs.waterbus.tech](https://docs.waterbus.tech)
- Flutter app [repository]()
- Server SFU WebSocket [repository]()
- 📃 Check document at [docs.waterbus.tech](https://docs.waterbus.tech)
- 📱 Flutter app [repository]()
- 📽️ Server SFU WebSocket [repository]()

<h4 align="center">Built with 💙 by the Waterbus team.</h4>
Binary file added images/arch-high-level-design-dark.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/arch-high-level-design-light.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed images/waterbus-roadmap-dark.gif
Binary file not shown.
Binary file added images/waterbus-roadmap-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed images/waterbus-roadmap-light.gif
Binary file not shown.
Binary file added images/waterbus-roadmap-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3dbc6df

Please sign in to comment.