From 26f8f5c36d39173433152daed7e1b5453d724fda Mon Sep 17 00:00:00 2001
From: Wuzzy <Wuzzy2@mail.ru>
Date: Fri, 28 Aug 2020 14:36:09 +0200
Subject: [PATCH] Document example holidays

---
 API.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/API.md b/API.md
index ce2e387..1a9426d 100644
--- a/API.md
+++ b/API.md
@@ -102,6 +102,28 @@ Holidays can be queried with `calendar.get_holidays`.
                         return true if it's a holiday and false if not.
                         Try to keep your calculations as simple as possible
 
+#### Examples
+```
+-- First day of every year
+calendar.register_holiday({
+	name = "New Year's Eve",
+	type = "monthday",
+	days = 0,
+	months = 0
+})
+
+-- First Sunday in May
+calendar.register_holiday({
+	name = "Mother's Day",
+	type = "custom",
+	is_holiday = function(total_days)
+		local d, m, y = calendar.get_date(total_days)
+		local wday = calendar.get_weekday(total_days)
+		return wday == 6 and m == 4 and d <= 6
+	end,
+})
+```
+
 ### `calendar.get_holidays(total_days)`
 Returns table of all holidays for the given day.