summaryrefslogtreecommitdiff
path: root/dynamic/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'dynamic/README.md')
-rw-r--r--dynamic/README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/dynamic/README.md b/dynamic/README.md
new file mode 100644
index 0000000..0f64827
--- /dev/null
+++ b/dynamic/README.md
@@ -0,0 +1,16 @@
+# Dynamic API for jakob.space
+
+This is a Guile back-end for all dynamic capabilities on jakob.space. It is
+assumed that the web server proxies all requests matching a `/api` prefix to
+this server.
+
+## Dependencies
+
+Depending on who you ask, the package management situation for Guile is either
+disappointing, or a pleasant reminder of simpler times. This module leverages
+two Guile modules which, to my knowledge, are not packaged in the typical Guile
+extension fashion. The respective `.scm` files will need to be downloaded and
+added to Guile load path.
+
+- [base64 from guile-lib](https://github.com/jacobrec/guile-lib/blob/master/base64.scm)
+- [squee](https://notabug.org/cwebber/guile-squee/)