Skip to content

Commit f4d565c

Browse files
committed
Update README with new omer functions
1 parent 5df5905 commit f4d565c

File tree

1 file changed

+55
-0
lines changed

1 file changed

+55
-0
lines changed

README.md

+55
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,19 @@ we omit the thousands (which is presently 5 [ה]).</p>
118118
Ignores final Hebrew letters such as <code>ך</code> (kaf sofit) or <code>ם</code> (mem sofit)
119119
and vowels (nekudot).</p>
120120
</dd>
121+
<dt><a href="#omerSefira">omerSefira(omerDay, lang)</a> ⇒</dt>
122+
<dd><p>Returns the sefira. For example, on day 8
123+
חֶֽסֶד שֶׁבִּגְבוּרָה
124+
Chesed shebiGevurah
125+
Lovingkindness within Might</p>
126+
</dd>
127+
<dt><a href="#omerTodayIs">omerTodayIs(omerDay, lang)</a> ⇒</dt>
128+
<dd><p>Returns a sentence with that evening&#39;s omer count</p>
129+
</dd>
130+
<dt><a href="#omerEmoji">omerEmoji(omerDay)</a> ⇒</dt>
131+
<dd><p>Returns an emoji number symbol with a circle, for example <code>㊲</code>
132+
from the “Enclosed CJK Letters and Months” block of the Unicode standard</p>
133+
</dd>
121134
</dl>
122135

123136
<a name="greg"></a>
@@ -395,3 +408,45 @@ and vowels (nekudot).
395408
| --- | --- |
396409
| str | <code>string</code> |
397410

411+
<a name="omerSefira"></a>
412+
413+
## omerSefira(omerDay, lang) ⇒
414+
Returns the sefira. For example, on day 8
415+
חֶֽסֶד שֶׁבִּגְבוּרָה
416+
Chesed shebiGevurah
417+
Lovingkindness within Might
418+
419+
**Kind**: global function
420+
**Returns**: a string such as `Lovingkindness within Might` or `חֶֽסֶד שֶׁבִּגְבוּרָה`
421+
422+
| Param | Description |
423+
| --- | --- |
424+
| omerDay | the day of the omer, 1-49 inclusive |
425+
| lang | `en` (English), `he` (Hebrew with nikud), or `translit` (Hebrew in Sephardic transliteration) |
426+
427+
<a name="omerTodayIs"></a>
428+
429+
## omerTodayIs(omerDay, lang) ⇒
430+
Returns a sentence with that evening's omer count
431+
432+
**Kind**: global function
433+
**Returns**: a string such as `Today is 10 days, which is 1 week and 3 days of the Omer`
434+
or `הַיוֹם עֲשָׂרָה יָמִים, שְׁהֵם שָׁבוּעַ אֶחָד וְשְׁלוֹשָׁה יָמִים לָעוֹמֶר`
435+
436+
| Param | Description |
437+
| --- | --- |
438+
| omerDay | the day of the omer, 1-49 inclusive |
439+
| lang | `en` (English), `he` (Hebrew with nikud) |
440+
441+
<a name="omerEmoji"></a>
442+
443+
## omerEmoji(omerDay) ⇒
444+
Returns an emoji number symbol with a circle, for example ``
445+
from the “Enclosed CJK Letters and Months” block of the Unicode standard
446+
447+
**Kind**: global function
448+
**Returns**: a single Unicode character from `` through ``
449+
450+
| Param | Description |
451+
| --- | --- |
452+
| omerDay | the day of the omer, 1-49 inclusive |

0 commit comments

Comments
 (0)