initial commit

we have a few basic data structures so far! (and a bunch of other
non-code stuff like doxygen)

1 files changed, 13 insertions, 0 deletions

diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 0000000..cf8fe99
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1,13 @@
+\mainpage
+
+**libsparklepaw** is a C library implementing large parts of the 
+[PawSD](https://pawpub.entities.org.uk/pawsd/) network protocol. It's intended
+to be used by other software to easily add support for PawSD, or as part of
+bigger PawSD software such as daemons or zone administration tools.
+
+See \ref examples.
+
+\warning This is still in development and therefore will have a very high
+bug-to-feature ratio! Don't use it for anything serious yet.
+
+\author [winter Sparkles](https://зима.net/)