aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorben <ben@nagy.contact>2025-05-13 17:04:31 -0700
committerben <ben@nagy.contact>2025-05-13 17:04:31 -0700
commitd57bb5ce35123755df396bbda6bfde9fca458b88 (patch)
tree3dfd87d600368774ffc82106f4d287187e934aad /README.md
parent11dd969710a979eb0ba497c51209e862c1298476 (diff)
License, acknowledgements, requirements, and installation
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 19 insertions, 1 deletions
diff --git a/README.md b/README.md
index b1b7161..ee846b3 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,19 @@
-init
+[![Built with matrix-nio](https://img.shields.io/badge/built%20with-matrix--nio-brightgreen)](https://github.com/poljar/matrix-nio)
+
+# Matrix-redact
+
+# Usage
+
+# Install
+
+1. Clone the repo and satisfy its dependencies
+```
+git clone https://github.com/arachnida82/matrix-redact
+cd matrix-redact
+python3.13 -m venv env
+source env/bin/activate
+pip install -r requirements.txt
+```
+
+# Licensing and Acknowledgement
+The Matrix redact program (matrix-redact) 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).