git hooks

2023-04-30 15:55:44 +03:00
parent f67def6a8d
commit 448fa22705
5 changed files with 84 additions and 3 deletions
--- a/docs/ru.md
+++ b/docs/ru.md
@@ -0,0 +1,42 @@
+# Документация
+
+## App
+
+Основной класс движка.
+
+При инициализации самостоятельно добавляет HTML элемент `<canvas>`
+в тег `<body>`.
+
+### Параметры
+
+- `w` — ширина холста в пикселях.
+- `h` — высота холста в пикселях.
+- `options` — объект опций.
+
+**Имеет следующую структуру:**
+
+```text
+{
+    backgroundColor: '#ffcc68',
+    welcome: true,
+}
+```
+
+- backgroundColor — фон холста.  
+  По умолчанию `#ffcc68`.
+
+- welcome — `bool` тип.  
+  Отображает информацию о движке в **Console**.  
+  По умолчанию `true`.
+
+### Пример использования
+
+```javascript
+// init app
+let app = new App(400, 400);
+
+// add app view in document
+window.addEventListener('DOMContentLoaded', () => {
+  document.body.appendChild(app.view);
+});
+```