Первая рабочая версия

2023-03-27 21:17:55 +04:00
parent 79c2afbb7e
commit dc6e613392
16 changed files with 357 additions and 144 deletions
@@ -1,3 +1,47 @@
 # Бибилотека первоапрельских розыгрышей для форумов MyBB

-Тут будет описание
+Базовое использование:
+```html
+<script src="https://static.kozhilya.ru/script/april-fools.min.js"></script>
+<script>
+    // Установка настроек системы
+    window.AprilJokes.settings = {
+        // ...
+    };
+</script>
+```
+
+Использование для тестирования:
+```html
+<script src="https://static.kozhilya.ru/script/april-fools.js"></script>
+<script>
+    // Установка настроек системы
+    window.AprilJokes.settings = {
+        // ...
+    };
+
+    // Создание новой шутки
+    window.AprilJokes.addCustom(
+        // ID шутки
+        'alert', 
+
+        // Вызываемая функция шутки
+        settings => alert(settings.text), 
+
+        // Стандартные настройки
+        {
+            chance: 30,
+            text: 'Fooled!',
+        }
+    );
+
+    // Запуск шутки
+    // true - отключает проверки случайности
+    window.AprilJokes.start('alert', true);
+</script>
+```
+
+В планах:
+* Отключение отдельных шуток для пользователей.
+
+О том, какие шутки определены по умолчанию, смотрите [тут](src/jokes).