Add README

.gitignore

@@ -13,6 +13,7 @@
 /resources/winsetup/bin
 /resources/win-chocolatey/tools/chocolateyinstall.ps1
 .vs
+*.json
 *.msi
 *.nupkg
 test/fixtures/**/.fbkpm

README.md

@@ -0,0 +1,38 @@
+# Server Pages
+
+Converts a [CSV](server-pages.csv) containing information about my 
+server pages into a JSON containing information about the pages' 
+status, update time and server uptime. Created for use on my personal 
+website's [server information page].
+
+[server information page]: https://kevin-mok.com/server/
+
+## Sample Output
+Running `node server-status.js` (after `npm i`) would produce the 
+following output:
+``` json
+{
+  "sites": [
+    {
+      "shortUrl": "kevin-mok.com",
+      "url": "https://kevin-mok.com",
+      "siteTitle": " Kevin Mok ",
+      "description": "Personal site (this site).",
+      "repo": "Kevin-Mok/my-site",
+      "repoUrl": "https://git.kevin-mok.com/Kevin-Mok/my-site",
+      "status": "up"
+    },
+    ...
+  ],
+  "updateTime": 1569209941343,
+  "upSince": "2019-09-22 19:30:10"
+}
+```
+
+## Built With
+
+* [csvtojson] - Convert my base CSV to JSON.
+* [url-metadata] - Fetch my pages for their titles.
+
+[csvtojson]: https://www.npmjs.com/package/csvtojson
+[url-metadata]: https://www.npmjs.com/package/url-metadata