Skip to content

Commit

Permalink
docs: add badges and discord link to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
max-niederman authored Apr 26, 2024
1 parent 59f08cf commit 5177a66
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
# Centipede

<p align="center">
<a href="https://discord.gg/3wJyrBsKXu">
<img src="https://img.shields.io/discord/1233267011963060275?logo=discord"
alt="chat on Discord"></a>
<img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/max-niederman/centipede/rust.yml">
<img alt="GitHub top language" src="https://img.shields.io/github/languages/top/max-niederman/centipede">
<img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/max-niederman/centipede">
<a href="https://github.com/max-niederman/centipede/graphs/contributors" alt="Contributors">
<img src="https://img.shields.io/github/contributors/max-niederman/centipede" /></a>
</p>

Centipede is a work-in-progress multipathing VPN for improving connection reliability and performance for mobile devices and site-to-site connections.

Like WireGuard, Centipede aims to provide a stateless user interface for establishing VPN connections.
Expand All @@ -10,6 +21,10 @@ This enables a few use cases, including
2. Balancing VPN connection load between multiple physical machines, without the client's knowledge.
3. Live migration of VPN connections between physical machines, without the other peer's knowledge.

## Support and Development

If you're interested in helping out with Centipede, need help using, or just want to hang out, [join the development Discord server](https://discord.gg/3wJyrBsKXu).

## Protocol and Implementation Overview

Centipede, like WireGuard, encapsulates IP packets in UDP datagrams encrypted with ChaCha20Poly1305 along with a small (32-byte) header.
Expand All @@ -35,4 +50,4 @@ In addition to userspace state, Centipede creates TUN queues and sets of UDP soc

Below are some benchmark results of Centipede against WireGuard's user- and kernel-space implementations.

![Benchmark results ](./benchmark.png)
![Benchmark results ](./benchmark.png)

0 comments on commit 5177a66

Please sign in to comment.