Skip to content

Commit

Permalink
Archive repository
Browse files Browse the repository at this point in the history
  • Loading branch information
jjanowsk committed Nov 26, 2024
1 parent 8be4648 commit a0d6d2f
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,23 @@
# ⚠️ This repository is soon to be archived and is kept only for maintanance purposes. The current developement is done under: https://github.com/NordSecurity/NepTUN

![boringtun logo banner](./banner.png)

# BoringTun

## Warning
Boringtun is currently undergoing a restructuring. You should probably not rely on or link to
Boringtun is currently undergoing a restructuring. You should probably not rely on or link to
the master branch right now. Instead you should use the crates.io page.

- boringtun: [![crates.io](https://img.shields.io/crates/v/boringtun.svg)](https://crates.io/crates/boringtun)
- boringtun-cli [![crates.io](https://img.shields.io/crates/v/boringtun-cli.svg)](https://crates.io/crates/boringtun-cli)

**BoringTun** is an implementation of the [WireGuard<sup>®</sup>](https://www.wireguard.com/) protocol designed for portability and speed.

**BoringTun** is successfully deployed on millions of [iOS](https://apps.apple.com/us/app/1-1-1-1-faster-internet/id1423538627) and [Android](https://play.google.com/store/apps/details?id=com.cloudflare.onedotonedotonedotone&hl=en_US) consumer devices as well as thousands of Cloudflare Linux servers.
**BoringTun** is successfully deployed on millions of [iOS](https://apps.apple.com/us/app/1-1-1-1-faster-internet/id1423538627) and [Android](https://play.google.com/store/apps/details?id=com.cloudflare.onedotonedotonedotone&hl=en_US) consumer devices as well as thousands of Cloudflare Linux servers.

The project consists of two parts:

* The executable `boringtun-cli`, a [userspace WireGuard](https://www.wireguard.com/xplatform/)
* The executable `boringtun-cli`, a [userspace WireGuard](https://www.wireguard.com/xplatform/)
implementation for Linux and macOS.
* The library `boringtun` that can be used to implement fast and efficient WireGuard client apps on various platforms, including iOS and Android. It implements the underlying WireGuard protocol, without the network or tunnel stacks, those can be implemented in a platform idiomatic way.

Expand Down

0 comments on commit a0d6d2f

Please sign in to comment.