瀏覽代碼

Update 'README.md'

Added a note about how this is a Dockerization, and how to run it.
mitch donaberger 2 月之前
父節點
當前提交
9909593142
共有 1 個文件被更改,包括 15 次插入1 次删除
  1. 15 1
      README.md

+ 15 - 1
README.md

@@ -1,4 +1,18 @@
-![Notice, this repository was mirrored to here from Github](https://m1s5.c20.e2-5.dev/files/images/mirror-notice.svg)
+# A dockerized version of a tool developed by Dragfyre
+This is a way for users to build Dockerized versions of Dragfyre's NodeJS-based Badí Calendar solver. Now you can can get a Badí calendar date on your shell, website, or boat!
+
+### Quick Start 🚀
+
+If you have `docker` installed already, you can give the server a shot by running the command `docker run -d -p 1844:1844 unmolded1457/bahai-date-api`. On Windows machines, that command might be `docker.exe run -d -p 1844:1844 unmolded1457/bahai-date-api`.
+
+This will open up a simple HTTP server on port `1844`, the same year on the Common Calendar wherein the Báb declared His station as the promised Mahdí, or, forebearer to the Messíah.
+
+You can test it by running `curl http://localhost:1844/today`. If you have `jq` installed, try `curl http://localhost:1844/today | jq -r '.message'`
+
+`jq` just takes the standard JSON output and allows you to extract specific values — get creative with it!
+
+If you want some more information on how to get this permanently running as a `Function as a Service`, check out `DOCKER-Readme.md`
+
 
 # Baháʼí Date RESTful API