From a6227e2c86763109694c82c79662244160cf9a42 Mon Sep 17 00:00:00 2001
From: Jacob McDonnell <jacob@simplelittledream.com>
Date: Wed, 13 Apr 2022 23:14:59 -0400
Subject: Initial Commit

---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..77bb558
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# cfetch
+This is a small program written in java to get the current liturgical day for the
+Catholic liturgical calendar. 
+
+The program is reliant on the api [liturgical Calendar](http://calapi.inadiutorium.cz/). The program implements the [JSON-java](https://github.com/stleary/JSON-java) library to parse the JSON output.
+
+## Building
+
+Cfetch is written in IntelliJ IDEA and thus should be built using it. To build a jar file, in IDEA click on the build menu and click on build artifacts.
+
+## Running
+
+To run cfetch, run the following command or put it in a shell script:
+```
+java -jar cfetch.jar
+```
+
+To run with a different day than today, run:
+```
+java -jar cfetch.jar 2022/12/01
+```
+The date must be formatted as YYYY/MM/DD.
\ No newline at end of file
-- 
cgit v1.2.3