1 files changed, 34 insertions, 1 deletions
diff --git a/lua/sandborb/README.md b/lua/sandborb/README.md
index fe81506..d625dae 100644
--- a/lua/sandborb/README.md
+++ b/lua/sandborb/README.md
@@ -1,3 +1,36 @@
 # sandborb
 
-Lua web fun playground.
\ No newline at end of file
+Lua web fun playground.
+
+[Sandbird](https://github.com/rxi/sandbird) is an MIT licensed embeddable HTTP server. Sandborb is my attempt to make it scriptable with lua. My goal isn't to use it in prod. or to scale to massive sizes, or even really ever deploy it, but to use this for small web experiments that I run locally or on my home network. I'm also hoping to learn a bit more C while I'm at it, since I really don't know much of it at all. 
+
+Sandborb also includes [json.lua](https://github.com/rxi/json.lua) to help with encoding and decoding json.
+
+## todo
+
+- [x] handle routing for get requests from lua
+- [x] handle routing for post requests from lua
+- [ ] pass post bodies to lua
+
+*** 
+
+Copyright (c) 2024 elioat
+
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.