summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTyler Murphy <tylerm@tylerm.dev>2023-07-02 18:46:21 -0400
committerTyler Murphy <tylerm@tylerm.dev>2023-07-02 18:46:21 -0400
commite1b357353567ae5de6c71578043e338c78143fd7 (patch)
treec5c01f7e874856f976cfb738196f54e6ff3f5822 /README.md
parenthi (diff)
downloadbashttp-e1b357353567ae5de6c71578043e338c78143fd7.tar.gz
bashttp-e1b357353567ae5de6c71578043e338c78143fd7.tar.bz2
bashttp-e1b357353567ae5de6c71578043e338c78143fd7.zip
reaname
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d68c6cc
--- /dev/null
+++ b/README.md
@@ -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