From 817e4506a09bfc1a6af8426a9ce00fec1171e2e7 Mon Sep 17 00:00:00 2001
From: Mark Poliakov <mark@alnyan.me>
Date: Sun, 7 Jan 2024 03:57:21 +0200
Subject: [PATCH] Add a README

---
 README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..45631c3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+stund
+=====
+
+A minimal asynchronous STUN server implementation.
+
+The server implements the minimal necessary functionality from
+[RFC 8489](https://datatracker.ietf.org/doc/html/rfc8489), namely
+the Binding Request.
+
+The server is both IPv6 and IPv4 capable. When listening on IPv6 address,
+the server is capable of handling IPv6/IPv4 clients.
+
+Running
+-------
+
+To try out the server, just run:
+
+```shell
+$ cargo run
+```
+
+Testing
+-------
+
+To verify the server functions properly, the following tools may be used:
+
+* [Trickle ICE tester from WebRTC github samples](https://webrtc.github.io/samples/src/content/peerconnection/trickle-ice/)
+* [IceTest.Info](https://icetest.info/)
+* `stunclient` package from [stunprotocol.org](stunprotocol.org).
+*Note: the server will report an error due to stunclient sending additional attributes not
+recognized by this implementation*