adding README

hastily written initial version :P

README.md

@@ -0,0 +1,89 @@
+# Baha'i Date RESTful API
+
+So far, there are two endpoints for this API:
+
+**GET /today**
+
+Returns today's date according to the Baha'i/Badi calendar.
+
+**POST /date**
+
+Given a date from the Gregorian calendar defined via POST data, returns the corresponding date in the Baha'i calendar.
+
+## Running
+
+To launch the API server, simply navigate to the main folder and type 'npm run start'.
+
+## Examples
+
+From either endpoint, the output is returned in a similar format: a JSON object containing a message, a Baha'i calendar date, and a Gregorian date/time.
+
+### Today
+
+URL: localhost:1844/today
+
+{
+    "message": "Today is 13 Masá’il 174",
+    "badi_date": {
+        "year": 174,
+        "month": 14,
+        "day": 13,
+        "month_name": "Masá’il"
+    },
+    "greg_date": {
+        "year": 2017,
+        "month": 12,
+        "day": 5,
+        "hour": 23,
+        "minute": 19,
+        "second": 12
+    }
+}
+
+### May 23, 1844
+
+URL: localhost:1844/date?year=1844&month=5&day=23&hour=20&minute=45
+
+Output:
+
+{
+    "message": "The date is: 9 ‘Aẓamat 1",
+    "badi_date": {
+        "year": 1,
+        "month": 3,
+        "day": 9,
+        "month_name": "‘Aẓamat"
+    },
+    "greg_date": {
+        "year": 1844,
+        "month": 5,
+        "day": 23,
+        "hour": 20,
+        "minute": 45,
+        "second": 0
+    }
+}
+
+### February 15, 2014
+
+URL: localhost:1844/date?year=2014&month=2&day=15&hour=13&minute=45
+
+Output:
+
+{
+    "message": "The date is: 10 Mulk 170",
+    "badi_date": {
+        "year": 170,
+        "month": 17,
+        "day": 10,
+        "month_name": "Mulk"
+    },
+    "greg_date": {
+        "year": 2014,
+        "month": 2,
+        "day": 15,
+        "hour": 13,
+        "minute": 45,
+        "second": 0
+    }
+}