# HG changeset patch
# User Kim Alvefur <zash@zash.se>
# Date 1697317559 -7200
# Node ID a5089978928a79ebc8da64981f2e9e83b52915cd
# Parent  799f69a5921aa3a0eba39474379af466acdcb959
mod_storage_s3: Add brief README

diff -r 799f69a5921a -r a5089978928a mod_storage_s3/README.md
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_storage_s3/README.md	Sat Oct 14 23:05:59 2023 +0200
@@ -0,0 +1,20 @@
+---
+labels:
+- 'Stage-Alpha'
+summary: Cloud Native Storage
+...
+
+::: {.alert .alert-danger}
+This storage driver is fully async and requires that all storage access happens in an async-compatible context. As of 2023-10-14 this work in Prosody
+is not yet complete. For now, this module is primarily suited for testing and finding areas where async work is incomplete.
+:::
+
+This module provides storage in Amazon S3 compatible things. It has been tested primarily with MinIO.
+
+``` lua
+s3_bucket = "prosody"
+s3_base_uri = "http://localhost:9000"
+s3_region = "us-east-1"
+s3_access_key = "YOUR-ACCESS-KEY-HERE"
+s3_secret_key = "YOUR-SECRET-KEY-HERE"
+```