diff --git a/README.md b/README.md index 9911269217a64a361dfa650b439444a464498b01..3fbec099246316348051a86b5f4a91c7532a2130 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,28 @@ # simplesamlphp-module-attribute_check - +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.