summaryrefslogtreecommitdiff
path: root/schemas/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'schemas/readme.md')
-rw-r--r--schemas/readme.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/schemas/readme.md b/schemas/readme.md
new file mode 100644
index 00000000..6ec41a46
--- /dev/null
+++ b/schemas/readme.md
@@ -0,0 +1,15 @@
+# Schemas
+
+This directory contains public schemas for the most important parts of application.
+
+**Do not rename or remove this directory or any file or directory inside.**
+
+- You can validate existing config file using the following command:
+
+ ```bash
+ $ docker run --rm -v "$(pwd):/src" -w "/src" node:14-alpine sh -c \
+ "npm install -g ajv-cli && \
+ ajv validate --all-errors --verbose \
+ -s ./schemas/config/2.0.schema.json \
+ -d ./.rr*.y*ml"
+ ```