1 files changed, 38 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..dc89f94
--- /dev/null
+++ b/README
@@ -0,0 +1,38 @@
+URLTOOL
+=======
+
+URL tool is a simple shell tool to encode and decode URI encoding as set by
+RFC3986.
+
+* `urltool` reads lines from files or stdin and encodes/decodes them onto stdout
+* `urlenc` and `urldec` are symlinks to `urltool` that read and encode/decode
+   their arguments and output to stdout.
+
+
+## Build & Install
+
+Only tested on Linux, but should be POSIX compliant. The only dependency is
+libc with getline(3).
+
+Just run `./build.sh` to build "normally", you can set $CC and $CFLAGS from env.
+If you have `musl-gcc` installed and prefer static executables like me, you can
+run `./build-musl.sh` to do so.
+
+By default a debug build with debug information is created. `./build.sh fast`
+to build with optimizations on. Assumes GCC-like flags.
+
+`./clean.sh` to remove the build artifacts.
+
+`./install.sh` to install to "${DESTDIR}${PREFIX}/${BINDIR}"
+
+The scripts are tiny so feel free to edit.
+
+
+## Why?
+
+To help me build shell pipelines that do HTTP GET requests and alike.
+See examples/.
+
+
+## Who?
+dweller from cabin.digital