Update user guide to clarify cron syntax on index page (#604)

alonsodomin · Jan 3, 2025 · e2f0230 · e2f0230
1 parent b44265f
commit e2f0230
Showing 1 changed file with 7 additions and 3 deletions.
diff --git a/docs/src/main/mdoc/userguide/index.md b/docs/src/main/mdoc/userguide/index.md
@@ -24,9 +24,13 @@ libraryDependencies += "com.github.alonsodomin.cron4s" %%% "cron4s-core" % "{{si
  * Seconds
  * Minutes
  * Hour Of Day
- * Day Of Month
- * Month
- * Day Of Week
+ * Day Of Month (1-31)
+ * Month (1-12)
+ * Day Of Week (0-6, where 0 is Monday)
+
+Textual values are also accepted for Month (`"jan"`, `"feb"`, `"mar"`, `"apr"`, `"may"`, `"jun"`, `"jul"`, 
+`"ago"`, `"sep"`, `"oct"`, `"nov"`, `"dec"`) and Day of Week (`"mon"`, `"tue"`, `"wed"`, `"thu"`, `"fri"`, `"sat"`, 
+`"sun"`).
 
 To parse a cron expression into a type that we can work with we will use the `Cron` smart constructor: