docs: Added description for Countries module

cheatsnake · Aug 24, 2022 · 6eb932a · 6eb932a
1 parent 6f163e8
commit 6eb932a
Showing 1 changed file with 60 additions and 0 deletions.
diff --git a/README_RU.md b/README_RU.md
@@ -26,6 +26,7 @@ Shadify – это мощный сервис генерации данных и
 -   [Minesweeper](#minesweeper)
 -   [Wordsearch](#wordsearch)
 -   [Anagram](#anagram)
+-	[Countries](#countries)
 
 ### Sudoku
 
@@ -511,6 +512,65 @@ GET https://shadify.dev/api/anagram/generator
 
 > `Task` - слово из которого необходимо составлять другие слова. <br> `Words` - массив всех возможных слов, которые составляются из `Task`. 
 
+### Countries
+
+Модуль Countries позволяет генерировать викторины, такие как "угадай столицу" или "угадай страну по изображению флага". Это простой и полезный модуль для создания приложений для проверки и тренировки знаний по всем странам мира.
+
+-   Генерация задания "угадай столицу"
+
+```rust
+GET https://shadify.dev/api/countries/capital-quiz
+```
+
+| Параметр    | Описание                                                                                                                         |
+| ----------- | -------------------------------------------------------------------------------------------------------------------------------- |
+| `variants`  | _Опциональный_ <br> Число от 2 до 6, соответствует количеству различных вариантов, из которых вы должны выбрать правильную столицу заданной страны. <br> Значение по умолчанию – 4. |
+
+Возвращаемый ответ:
+
+```json
+{
+	"country": "Cyprus",
+	"flag": "https://flagcdn.com/w320/cy.png",
+	"variants": [
+		"Nicosia",
+		"Juba",
+		"Oslo",
+		"Jamestown"
+	],
+	"answer": "Nicosia"
+}
+```
+
+> `country` - страна для которой вы должны угадать столицу. <br> `flag` - изображение флага страны (взято из [Flagpedia API](https://flagpedia.net/download/api), можно кастомизировать). <br> `variants` - массив возможных вариантов ответа. <br> `answer` - правильный ответ.
+
+-   Генерация задания "угадай страну по изображению флага"
+
+```rust
+GET https://shadify.dev/api/countries/country-quiz
+```
+
+| Параметр    | Описание                                                                                                                         |
+| ----------- | -------------------------------------------------------------------------------------------------------------------------------- |
+| `variants`  | _Опциональный_ <br> Число от 2 до 6, соответствует количеству различных вариантов, из которых вы должны выбрать правильную страну по заданному изображению флага. <br> Значение по умолчанию – 4. |
+
+Возвращаемый ответ:
+
+```json
+{
+	"flag": "https://flagcdn.com/w320/dk.png",
+	"variants": [
+		"Yemen",
+		"Denmark",
+		"Norfolk Island",
+		"Vietnam"
+	],
+	"answer": "Denmark"
+}
+```
+
+> `flag` - изображение флага страны, которую вы должны угадать. <br> `variants` - массив возможных вариантов ответа. <br> `answer` - правильный ответ.
+
 ## Запуск локального сервера
 
 1. Склонируйте этот репозиторий к себе на компьютер: