From 1a3d3ac97bbf6bdb3c655e5a685211354e08ba1b Mon Sep 17 00:00:00 2001
From: dmitry_k <dmitry_k@example.local>
Date: Mon, 1 Apr 2024 07:54:36 +0000
Subject: [PATCH] Update README.md

---
 README.md | 85 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 84 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 109cb7b..6778959 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,84 @@
-# Файл шаблона для новых репозиториев
\ No newline at end of file
+# Файл шаблона для новых репозиториев
+
+Для дальнейшей работы необходимо:
+* добавить субмодуль со скриптами: git submodule add https://gitea.kdiva.ru/modules/helper-scripts.git
+* заполнить поля в `module.json.template`
+
+```json
+  "id": "",
+  "name": "",
+  "title": "",
+  "description": "",
+  ...
+  "packs": []
+```
+`packs` может включать в себя следующие элементы:
+
+```json
+    {		
+      "name": "actors",		
+      "label": "new adventure template",		
+      "path": "/packs/actors.db",		
+      "entity": "Actor",		
+      "type": "Actor",		
+      "system": "dnd5e"		
+    },		
+    {		
+      "name": "adventure",		
+      "label": "new adventure template",		
+      "path": "/packs/adventure.db",		
+      "entity": "Adventure",		
+      "type": "Adventure",		
+      "system": "dnd5e"		
+    },		
+    {		
+      "name": "cards",		
+      "label": "new adventure template",		
+      "path": "/packs/cards.db",		
+      "entity": "Cards",		
+      "type": "Cards"		
+    },		
+    {		
+      "name": "items",		
+      "label": "new adventure template",		
+      "path": "/packs/items.db",		
+      "entity": "Item",		
+      "type": "Item",		
+      "system": "dnd5e"		
+    },		
+    {		
+      "name": "journals",		
+      "label": "new adventure template",		
+      "path": "/packs/journals.db",		
+      "entity": "JournalEntry",		
+      "type": "JournalEntry"		
+    },		
+    {		
+      "name": "macros",		
+      "label": "new adventure template",		
+      "path": "/packs/macros.db",		
+      "entity": "Macro",		
+      "type": "Macro"		
+    },		
+    {		
+      "name": "maps",		
+      "label": "new adventure template",		
+      "path": "/packs/maps.db",		
+      "entity": "Scene",		
+      "type": "Scene"		
+    },		
+    {		
+      "name": "playlists",		
+      "label": "new adventure template",		
+      "path": "/packs/playlists.db",		
+      "entity": "Playlist",		
+      "type": "Playlist"		
+    },		
+    {		
+      "name": "rolltables",		
+      "label": "new adventure template",		
+      "path": "/packs/rolltables.db",		
+      "entity": "RollTable",		
+      "type": "RollTable"		
+    }
+```
\ No newline at end of file