diff --git a/README.md b/README.md
index df1c3aa1..e43cf3a0 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,8 @@
 
 a smaller version of crystallib with only the items we need for hero
 
+> [documentation here](https://freeflowuniverse.github.io/herolib/)
+
 ## automated install
 
 ```bash