Add synopsis

hebcal · Nov 21, 2023 · 3def72d · 3def72d
1 parent fcbf8c1
commit 3def72d
Showing 1 changed file with 17 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,2 +1,18 @@
-# hdate-js
+# @hebcal/hdate
 converts between Hebrew and Gregorian dates
+
+[![Build Status](https://github.com/hebcal/hdate-js/actions/workflows/node.js.yml/badge.svg)](https://github.com/hebcal/hdate-js/actions/workflows/node.js.yml)
+
+# Installation
+```bash
+$ npm install @hebcal/hdate
+```
+
+## Synopsis
+```javascript
+import {greg, abs2hebrew} from '@hebcal/hdate';
+
+const date = new Date(2008, 10, 13); // 13 November 2008
+const abs = greg.greg2abs(date);
+const hdate = abs2hebrew(abs); // {yy: 5769, mm: CHESHVAN, dd: 15}
+```