From 5d1cff98b96d32a0422f9d8b8d79c96a6be13e04 Mon Sep 17 00:00:00 2001 From: Evan Pratten Date: Thu, 3 Aug 2023 23:45:26 -0400 Subject: [PATCH] wip readme --- README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9875b37..39be8fd 100644 --- a/README.md +++ b/README.md @@ -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