From bf69b52666b3cbbcba378d6296f1620832df7e65 Mon Sep 17 00:00:00 2001
From: ben <ben@nagy.contact>
Date: Sun, 4 May 2025 12:57:54 -0700
Subject: LICENSE, Acknowledgements, and Dependencies

---
 README.md | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index b1b7161..57d148c 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,22 @@
-init
+[![Built with matrix-nio](https://img.shields.io/badge/built%20with-matrix--nio-brightgreen)](https://github.com/poljar/matrix-nio)
+
+# Matrix-mcnt
+Matrix message count outputs the number of unread messages of all or of specified rooms to stdout.
+
+
+# Usage
+
+# Install
+
+1. Clone the repo and satisfy dependencies
+```
+git clone https://github.com/arachnida82/matrix-mcnt
+cd matrix-mcnt
+python3.13 -m venv env
+source env/bin/activate
+pip install -r requirements.txt
+```
+
+
+# Licensing and Acknowledgement
+The Matrix Message Count program (matrix-mcnt) is licensed under [GPL-3.0](https://www.gnu.org/licenses/gpl-3.0.en.html). It uses [matrix-nio](https://github.com/matrix-nio/matrix-nio) under the [Apache-2.0 license](https://www.apache.org/licenses/LICENSE-2.0.html) and [Internet Systems Consortium license (ISC)](https://www.isc.org/licenses/). A copy of the GPL-3.0 license has been produced [below](https://github.com/arachnida82/matrix-mcnt/blob/main/LICENSE.txt).
-- 
cgit v1.2.3