Skip to content

Enhance README with mermaid flowcharts #95

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Enhance README with mermaid flowcharts #95

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 26 additions & 21 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,35 +35,40 @@ Basic features:

### Useful in these situations

```mermaid
flowchart LR
Internet -- eth0/wlan0 --> Linux
Linux -- wlanX --> AP
AP --> Client1
AP --> Client2
```
Internet----(eth0/wlan0)-Linux-(wlanX)AP
|--client
|--client
```
```mermaid
flowchart LR
WiFi_AP["WiFi AP (no DHCP)"] -- wlan1 --> Linux
Linux -- eth0/wlan0 (DHCP) --> Internet
WiFi_AP --> Client1
WiFi_AP --> Client2

```
Internet
WiFi AP(no DHCP) |
|----(wlan1)-Linux-(eth0/wlan0)------
| (DHCP)
|--client
|--client
```

```
Internet
Switch |
|---(eth1)-Linux-(eth0/wlan0)--------
|--client
|--client
```mermaid
flowchart LR
Switch -- eth1 --> Linux
Linux -- eth0/wlan0 --> Internet
Switch --> Client1
Switch --> Client2
```

```
Internet----(eth0/wlan0)-Linux-(eth1)------Another PC
```mermaid
flowchart LR
Internet -- eth0/wlan0 --> Linux
Linux -- eth1 --> Another_PC["Another PC"]
```

```
Internet----(eth0/wlan0)-Linux-(virtual interface)-----VM/container
```mermaid
flowchart LR
Internet -- eth0/wlan0 --> Linux
Linux -- virtual interface --> VM["VM / Container"]
```

## Install
Expand Down