diff --git a/README.md b/README.md index bdf73a0..3dc9480 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,28 @@ # cerebrate The Cerebrate Sync Platform core software + +Cerebrate is an open-source platform meant to act as a trusted contact information provider and interconnection orchestrator for other security tools. + +It is currently being built under the Melicertes v2 project and is heavily work in progress. + +Currently it maintains a repository of organisations and individuals along with signing keys and their affiliations. + +The platform is built on CakePHP 4 along with Bootstrap 4 and shares parts of the code-base with MISP. + +#### Screnshots + +List of individuals along with their affiliations + +![List of individuals](/documentation/images/individuals.png) + +Adding organisations + +![Adding an organisation](/documentation/images/orgs_api.png) + +Everything is available via the API, here an example of a search query for all international organisations in the DB. + +![API query](/documentation/images/orgs_api.png) + +Managing public keys and assigning them to users both for communication and validating signed information shared in the community + +![Encryption key management](add_encryption_key.png) diff --git a/documentation/images/add_encryption_key.png b/documentation/images/add_encryption_key.png new file mode 100644 index 0000000..71b7423 Binary files /dev/null and b/documentation/images/add_encryption_key.png differ diff --git a/documentation/images/add_org.png b/documentation/images/add_org.png new file mode 100644 index 0000000..8cd26ae Binary files /dev/null and b/documentation/images/add_org.png differ diff --git a/documentation/images/alignment.png b/documentation/images/alignment.png new file mode 100644 index 0000000..80dab83 Binary files /dev/null and b/documentation/images/alignment.png differ diff --git a/documentation/images/individuals.png b/documentation/images/individuals.png new file mode 100644 index 0000000..80e12a4 Binary files /dev/null and b/documentation/images/individuals.png differ diff --git a/documentation/images/orgs_api.png b/documentation/images/orgs_api.png new file mode 100644 index 0000000..a87875e Binary files /dev/null and b/documentation/images/orgs_api.png differ