[refs #281898] Update readme.

README.md

@@ -0,0 +1,52 @@
+# pas.plugins.eea
+
+Provides user and group enumeration on top of pas.plugins.authomatic
+
+Features
+
+- user enumeration
+- groups enumeration
+- group member enumeration
+- user group enumeration
+
+# Documentation
+
+This addon depends on [pas.plugins.authomatic](https://github.com/collective/pas.plugins.authomatic).
+Upon installation, it will automatically run the setup step for `pas.plugins.authomatic`.
+
+In order for this plugin to function correctly, the Entra ID application should be granted the following **API
+permissions** in the `Microsoft.Graph` scope via the Azure Portal:
+
+- `Group.Read.All`
+- `GroupMember.Read.All`
+- `User.Read.All`
+
+The type for all the permissions is `Application` and _"Admin consent"_ must be granted.
+
+# Installation
+
+Install pas.plugins.eea by adding it to your buildout::
+
+    [buildout]
+
+    ...
+
+    eggs =
+        pas.plugins.eea
+
+and then running ``bin/buildout``
+
+After enabling the product in Site Setup -> Add-ons, make sure to:
+
+- go into Site Setup -> Authomatic (OAuth2/OpenID) and make sure that _"Generator for Plone User IDs."_ is set to *
+  *Provider User ID**.
+- update the JSON configuration
+
+# Contribute
+
+- Issue Tracker: https://github.com/eea/pas.plugins.eea/issues
+- Source Code: https://github.com/eea/pas.plugins.eea
+
+# License
+
+The project is licensed under the GPLv2.