From 3318b2ba935f1352069a3d34171af801f2be6c7c Mon Sep 17 00:00:00 2001
From: "Antonio J. Delgado" <ad@susurrando.com>
Date: Tue, 28 Nov 2023 23:15:13 +0200
Subject: [PATCH] update readme

---
 README.md | 48 +++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 47 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 1b13049..14472c8 100644
--- a/README.md
+++ b/README.md
@@ -39,8 +39,54 @@ You need to generate these secrets:
 
 ## Usage
 
+```yaml
+classes:
+  - mastodon
+
+mastodon::hostname: mastodon.example.org
+mastodon::db_host: /var/run/postgresql
+mastodon::db_port: 5432
+mastodon::db_name: mastodon
+mastodon::db_user: mastodon
+mastodon::users:
+  - username: my_custom_admin
+    email: admin@example.org
+    confirmed: true
+    role: Owner
+mastodon::config:
+  SINGLE_USER_MODE: false
+  REDIS_HOST: 127.0.0.1
+  SMTP_SERVER: 127.0.0.1
+  SMTP_PORT: 25
+  SMTP_AUTH_METHOD: none
+  SMTP_OPENSSL_VERIFY_MODE: none
+  SMTP_ENABLE_STARTTLS: auto
+  SMTP_FROM_ADDRESS: 'Mastodon <notifications@example.org>'
+```
+
+And some secrets in eyaml (you can do a first run that fails and
+then run ```RAILS_ENV=production bundle exec rake mastodon:setup``` to create this secrets).
+
+```yaml
+mastodon::db_password: >
+  ENC[PKCS7,]
+
+mastodon::secret_key_base: >
+  ENC[PKCS7,]
+
+mastodon::otp_secret: >
+  ENC[PKCS7,]
+
+mastodon::vapid_private_key: >
+  ENC[PKCS7,]
+
+mastodon::vapid_public_key: >
+  ENC[PKCS7,]
+```
 ## Limitations
 
+Tested in Ubuntu
+
 ## Development
 
-## Release Notes/Contributors/Etc. **Optional**
+## Release Notes/Contributors/Etc.