From f89b6d7ea0034c394bea4f8ef8c0a4e6bcd01e55 Mon Sep 17 00:00:00 2001
From: Jon Dybeck <jon.dybeck@liu.se>
Date: Tue, 15 Oct 2024 08:58:15 +0200
Subject: [PATCH] Update readme

---
 README.md | 28 ++++++++++++++++++++++------
 1 file changed, 22 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 70e8774..920c0ac 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,26 @@
 # stellar_account_database
 
-## Documentation ideas
+## Description
 
-For more ideas about what to document here see the [pdk template
-readme](https://github.com/puppetlabs/pdk-templates/blob/main/moduleroot_init/README.md.erb).
+This configures an OpenLDAP server and initializes it for use by
+[AI Academy](https://liu.se/en/research/ai/ai-academy) and computers in the "Stellar" system.
+It also installs and configures scripts for account management.
+This is not intended to be reused outside of that purpose.
 
-For how to do it:
-https://puppet.com/docs/puppet/latest/puppet_strings.html
-https://puppet.com/docs/puppet/latest/puppet_strings_style.html
+# Setup
+
+Add `stellar_account_database::role::server`. No parameters should be necessary.
+
+## Effects
+
+* Installs OpenLDAP server
+* Writes certs
+* Initializes a skeleton LDAP database
+ 
+# References
+
+* Owning organization is [AI Academy](https://liu.se/en/research/ai/ai-academy)
+* Client configuration can be found in [BaolOps](https://gitlab.liu.se/stellar/baolops)
+* User support info is at [Support](https://gitlab.liu.se/stellar/support)
+
+* Production host: kraz.ida.liu.se
-- 
GitLab