diff --git a/README.md b/README.md index 673669f..b3848d8 100644 --- a/README.md +++ b/README.md @@ -6,3 +6,23 @@ A simple and trivial IPv6 stack for Arduino. Currently implements: * ICMP Router Advertisement * UDP server +# Quick start +Browse `examples` directory for Arduino sketches. + +``` +cd examples/simple-udp-server +make build +make flash +``` + +# Configuration +`src/settings.h`: + +* `ENABLE_SLAAC`: enable stateless auto-configuration + +# Issues +* bugs: + * only known features +* nice-to-have: + * settings configuration outside library directory +