Update README.md

ShulV · Nov 9, 2023 · 3b9d62a · 3b9d62a
1 parent 1a57df6
commit 3b9d62a
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -13,3 +13,15 @@ download last veriosn from https://github.com/ShulV/Xmap/tree/main/postman and i
 
 ### How to view the relational model of a database:
 download and open in special UML-tools: https://github.com/ShulV/Xmap/blob/main/uml/relation_model.csv
+
+### How to write logs:
+<ul>
+  <li>Use snakecase for variables</li>
+  <li>Write variables in square brackets ('[', ']')</li>
+  <li>Write a colon (':') before variables block</li>
+  <li>.atInfo() - informing, .atWarn() - warnings, .atError - critical errors</li>
+</ul>
+
+```java
+logger.atInfo().log("Image info created: [image_info_id = '{}']", imageInfo.getId());
+```