summaryrefslogtreecommitdiff
path: root/docs/misc/holiday.md
diff options
context:
space:
mode:
authorilotterytea <iltsu@alright.party>2024-05-19 00:16:04 +0500
committerilotterytea <iltsu@alright.party>2024-05-19 00:16:04 +0500
commitecca9314a53b961f49ae57528e30a3a17f5300dc (patch)
treef99110ad90b9798b873c1c9ea4fdfba7aa45c34d /docs/misc/holiday.md
parent21991b1da2bfab5aa266e7ba91527a6ee62a6b99 (diff)
feat: docs
Diffstat (limited to 'docs/misc/holiday.md')
-rw-r--r--docs/misc/holiday.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/docs/misc/holiday.md b/docs/misc/holiday.md
new file mode 100644
index 0000000..90297c8
--- /dev/null
+++ b/docs/misc/holiday.md
@@ -0,0 +1,37 @@
+# Holiday
+
+The `!holiday` command allows you to get information about today's and upcoming holidays.
+
+
+> **So far, only Russian holidays and in Russian.**
+
+
+## Syntax
+
+`!holiday [date]`
+
++ `[date]` (Optional) - The date on which you want to get a random holiday.
+If it's not specified, today's date will be used.
+
+## Usage
+
++ `!holiday` - Get today's random holiday.
++ `!holiday 25.02` - Get a random holiday on February 25th.
++ `!holiday 25` - Get a random holiday on the 25th of this month.
++ `!holiday .02` - Get a random holiday for today's date in February *(e.g. if today is the 1st, then it's February 1st)*.
++ `!holiday yesterday` - Get yesterday's random holiday.
++ `!holiday tommorow` - Get tommorow's random holiday.
+
+## Response
+
++ `Holiday for 25.02 (3/8): День открытия спирта`
+
+## Important notes
+
++ The information is obtained from the third-party service ["ilotterytea/holidays"](https://hol.ilotterytea.kz)
+
+## Error handling
+
++ [Incorrect argument](/wiki/errors#3)
++ [External API error](/wiki/errors#20)
++ [Something went wrong](/wiki/errors#127)