aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..73d6484
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# purl-rs
+A simple URL-shortener in Rust.
+
+I created this URL-shortener because it turned out that my previous one, `purl`,
+which was written i perl, was impractical to run in a `chroot` environment.
+
+This new one, written in [Rust](https://www.rust-lang.org/), has far fewer
+dependencies to worry about in a `chroot` environment. It is written as a
+replacement for the old `purl`, and therefor uses
+[CGI](https://en.wikipedia.org/wiki/Common_Gateway_Interface).
+
+I use Nginx as my web-proxy, and run the cgi-binaries through
+[slowcgi(8)](https://man.openbsd.org/slowcgi). See `nginx.conf` for
+example-configuration.