1 files changed, 25 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..d68c6cc
--- /dev/null
+++ b/README
@@ -0,0 +1,25 @@
+# bashttp
+
+A very goofy http server that runs scripts based of the given URI route
+
+## Config
+
+All routs and scripts must be layed out in a file called config, or you can specift the path by setting the `CONFIG_PATH` env variable.
+
+An example config is shown below
+```
+/ ./hello_world
+/neo /usr/bin/neofetch
+/joe ./bide
+```
+As shown above, each route to script is a single line seperated by a single space.
+
+## License
+
+This project is licensed under the [WTFPL](https://www.wtfpl.net/)
+
+## Warrenty
+
+This project is probably not secure and if it beaks, uh... have fun
+
+...wtfpl