From 93ff9ed6fd9f2ca15cf6a8930eae26c9f5c65450 Mon Sep 17 00:00:00 2001
From: Pjotr Prins
Date: Sun, 24 Sep 2023 14:49:53 -0500
Subject: Simple gn-guile system container builds

---
 services/README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
 create mode 100644 services/README.md

(limited to 'services/README.md')

diff --git a/services/README.md b/services/README.md
new file mode 100644
index 0000000..d0d1c01
--- /dev/null
+++ b/services/README.md
@@ -0,0 +1,17 @@
+# Services
+
+This directory contains small and simple services that may be run independently.
+Note that composition is not the goal.
+For example, databases and web proxies are handled outsite the containers.
+Use these services for simple deployment and ad hoc testing.
+One nice aspect of small system containers is that you can run these easily on your laptop.
+
+IMPORTANT: more complex services do not belong in this directory.
+
+# Examples
+
+## gn-guile
+
+`gn-guile` is our next generation service (gn4?). It provides a REST API, at this point, and some portals, such as https://aging.genenetwork.org/.
+
+See the [gn-guile](./gn-guile.scm) system definition example.
-- 
cgit v1.2.3