You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by bd...@apache.org on 2022/09/07 16:48:33 UTC
[directory-scimple] branch develop updated: Build and module info to README
This is an automated email from the ASF dual-hosted git repository.
bdemers pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/directory-scimple.git
The following commit(s) were added to refs/heads/develop by this push:
new 4a8abc42 Build and module info to README
4a8abc42 is described below
commit 4a8abc421457fe057b1197e06feccc910af79ed3
Author: Brian Demers <bd...@apache.org>
AuthorDate: Wed Sep 7 12:47:51 2022 -0400
Build and module info to README
---
README.md | 29 +++++++++++++++++++++++++++++
1 file changed, 29 insertions(+)
diff --git a/README.md b/README.md
index e1869def..52353544 100644
--- a/README.md
+++ b/README.md
@@ -113,3 +113,32 @@ public class InMemoryUserService implements Respository<ScimUser> {
```
Implementing the repository interface allows the customization of create, retrieve, update, and delete methods (as well as find). Customization is flexible - if your system implements soft deletes, create a delete method that simply sets a flag and alter the find and retrieve methods to only return "undeleted" resources.
+
+## Building & Contributing
+
+Clone the code and build it!
+
+**Prerequisites**
+
+* Java 11+
+
+```bash
+git clone https://github.com/apache/directory-scimple.git
+cd directory-scimple
+./mvnw package
+# or on windows
+# mvnw.bat package
+```
+
+### Project modules
+
+| Name | Description |
+|------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| scim-spec/scim-spec-schema | SCIM relate models from [RFC7643](https://www.rfc-editor.org/rfc/rfc7643.html) and Filter related models from [RFC7644](https://www.rfc-editor.org/rfc/rfc7644.html) |
+| scim-spec/scim-spec-protocol | All other REST related models from [RFC7644](https://www.rfc-editor.org/rfc/rfc7644.html) |
+| scim-client | A SCIM REST Client |
+| scim-core | SCIMple Repository related classes, used to provide CRUD operations to a data store (e.g. a database), see above example |
+| scim-server | REST Endpoint implementations |
+| scim-server-examples | Various server examples |
+| scim-compliance-tests | Integration tests that can be used to test a SCIM server |
+