Skip to content

Commit

Permalink
Architecture diagram for README page. (#15)
Browse files Browse the repository at this point in the history 
Pictures make things easier to see what is going on.
  • Loading branch information
@markmandel
markmandel authored Jan 29, 2020
1 parent c4d0f8f commit d9f3a03
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,32 @@ Project is currently in *alpha* status, and is being actively developed. Expect

Not to be used in production systems.

## Proposed Architecture
```
+ +
| |
Internet Private
| Network
| +-------------+ | +----------------+
| |Quilkin Proxy| | | Dedicated Game |
| +-->+(Receiver) +---------+------> Server |
+---------+ +-------------+ | | | | | | | |
| Game | |Quilkin Proxy+------+ --------------+ | | +----------------+
| Client +------>+(Sender) | | | | |
+---------+ +-------------+ | | +-------------+ | | +----------------+
| | |Quilkin Proxy| | | | Dedicated Game |
| +-->+(Receiver) +---------+ | Server |
| | | | | |
| +-------------+ | +----------------+
| |
| +-------------+ | +----------------+
| |Quilkin Proxy| | | Dedicated Game |
| |(Receiver) | | | Server |
| | | | | |
| +-------------+ | +----------------+
+ +
```

## Usage

`quilkin --filename="configuration.yaml"`
Expand Down

0 comments on commit d9f3a03

Please sign in to comment.