aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authormurilo ijanc2026-03-24 23:48:42 -0300
committermurilo ijanc2026-03-24 23:50:57 -0300
commita156b6d104d846cc6d438a6d1368485e7eafd7e0 (patch)
treeb29aa20f270bcecbe600502088054c689683c975 /README.md
parent9821aabf0b50d2487b07502d3d2cd89e7d62bdbe (diff)
downloadtesseras-dht-a156b6d104d846cc6d438a6d1368485e7eafd7e0.tar.gz
Add brief project description to README
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 23 insertions, 2 deletions
diff --git a/README.md b/README.md
index e70a247..8cbe3d7 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,26 @@
-# tesseras-dht
+# Tesseras-DHT
+
+A NAT-aware Kademlia DHT library for Rust, designed for decentralized peer-to-peer networking.
+
+## Features
+
+- Distributed key-value storage (iterative FIND_NODE, FIND_VALUE, STORE)
+- NAT traversal via DTUN hole-punching and proxy relay
+- Reliable Datagram Protocol (RDP) with 7-state connection machine
+- Datagram transport with automatic fragmentation/reassembly
+- Ed25519 packet authentication
+- 256-bit node IDs (Ed25519 public keys)
+- Rate limiting, ban list, and eclipse attack mitigation
+- Persistence and metrics
+
+## Links
+
+- [Website](https://tesseras.net)
+- [Source code](https://got.tesseras.net/?action=summary&path=tesseras-dht.git) (primary)
+- [Source hut mirror](https://git.sr.ht/~ijanc/tesseras)
+- [GitHub mirror](https://github.com/ijanc/tesseras)
## License
-ISC
+ISC — see [LICENSE](LICENSE).
+