1 files changed, 33 insertions, 0 deletions
diff --git a/library/README.md b/library/README.md
new file mode 100644
index 00000000..43a1d318
--- /dev/null
+++ b/library/README.md
@@ -0,0 +1,33 @@
+# Custom Modules
+## Table of Contents
+  - [Description](#description)
+  - [Protocols](#protocols)
+      - [ocserv.py](#ocserv.py)
+	  - [xray.py](#xray.py)
+      - [sshvpn.py](#sshvpn.py)
+      - [hysteria.py](#hysteria.py)
+
+## Description
+Custom modules for user management for different protcols. Each module takes a list of users as input, writes to configuration or password file, returns a list of usernames and passwords that are printed at the end of playbook run. 
+
+ ## Protocols
+### xray.py
+Description: User management module for xray (vless, vmess, trojan)
+Input Parameters:
+- users - all_users + vless_users/vmess_users/trojan_users
+- protocol - vless/vmess/trojan
+
+### ocserv.py
+Description: User management module for ocserv
+Input Parameters:
+- users - all_users + ocserv_users
+
+### hysteria.py
+Description: User management module for hysteria
+Input Parameters:
+- users - all_users + hysteria_users
+
+### sshvpn.py
+Description: User management module for sshvpn
+Input Parameters:
+- users - all_users + sshvpn_users