From ef1487c8ac19714a81efe33a0377e57baf90bd74 Mon Sep 17 00:00:00 2001
From: Dominik Frantisek Bucik <bucik@ics.muni.cz>
Date: Tue, 2 Jan 2024 09:51:34 +0100
Subject: [PATCH] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20Fill=20readme,=20r?=
 =?UTF-8?q?emove=20unmantained=20status?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 27 +++++++++++++++++++++++++--
 1 file changed, 25 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 9911269..3fbec09 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,28 @@
 # simplesamlphp-module-attribute_check
 
-![maintenance status: unmaintained](https://img.shields.io/maintenance/end%20of%20life/2022)
+SimpleSAMLphp module for deploying an SP serving as an attribute check.
+
+## Configuration
+
+See `config-templates` directory on how to configure the module.
+
+## Contribution
+
+This repository uses [Conventional Commits](https://www.npmjs.com/package/@commitlint/config-conventional).
+
+Any change that significantly changes behavior in a backward-incompatible way or requires a configuration change must be marked as BREAKING CHANGE.
+
+### Available scopes:
+
+- theme
+- Auth Process filters:
+  - computeloa
+  - iscesneteligible
+  - iseinfraczeligible
+  - iseinfraassured
+
+## Instalation
+
+`php composer.phar require cesnet/simplesamlphp-module-attribute_check`
+
 
-This project is not maintained anymore, which means it does not receive any Security patches or bug fixes. Check out [SATOSA](https://github.com/IdentityPython/SATOSA) and various microservices instead.
-- 
GitLab