evan/protomask
1
Fork 0
Code

wip readme

Browse Source
This commit is contained in:
Evan Pratten 2023-08-03 23:45:26 -04:00
parent bb3e2c2a70
commit 5d1cff98b9
1 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -1,11 +1,21 @@
# protomask
[![Crates.io](https://img.shields.io/crates/v/protomask)](https://crates.io/crates/protomask)
[![Build](https://github.com/Ewpratten/protomask/actions/workflows/build.yml/badge.svg)](https://github.com/Ewpratten/protomask/actions/workflows/build.yml)
[![GitHub release](https://img.shields.io/github/v/release/ewpratten/protomask)](https://github.com/ewpratten/protomask/releases/latest)
[![Build](https://github.com/Ewpratten/protomask/actions/workflows/build.yml/badge.svg)](https://github.com/ewpratten/protomask/actions/workflows/build.yml)
[![Audit](https://github.com/ewpratten/protomask/actions/workflows/audit.yml/badge.svg)](https://github.com/ewpratten/protomask/actions/workflows/audit.yml)
**A user space [NAT64](https://en.wikipedia.org/wiki/NAT64) implementation.**
*This section is WIP*
This repository contains:
- `protomask`: The main NAT64 daemon
- `protomask-clat`: A Customer-side transLATor (CLAT) implementation
- `easy-tun`: A minimal TUN interface library
- `fast-nat`: A library designed for highly efficient mapping and lookup of IP address pairs
- `interproto`: A library for translating packets between protocols
- `rfc6052`: A Rust implementation of RFC6052
- `rtnl`: A high-level wrapper around `rtnetlink`
For user-oriented documentation, see the [protomask website](https://protomask.ewpratten.com).
## Installation