docs: change README (#2)

.licenserc.yaml

@@ -9,6 +9,7 @@ header:
     - '**'
   paths-ignore:
     - '.github/**'
+    - '.trivyignore'
     - '**/*.json'
     - '**/*.md'
     - '**/*.txt'

.trivyignore

@@ -0,0 +1,2 @@
+# Pebble CVE
+CVE-2024-34156

README.md

@@ -7,20 +7,44 @@ Avoid using this README file for information that is maintained or published els
 
 Use links instead.
 -->
+[![CharmHub Badge](https://charmhub.io/maubot/badge.svg)](https://charmhub.io/maubot)
+[![Publish to edge](https://github.com/canonical/maubot-operator/actions/workflows/publish_charm.yaml/badge.svg)](https://github.com/canonical/maubot-operator/actions/workflows/publish_charm.yaml)
+[![Promote charm](https://github.com/canonical/maubot-operator/actions/workflows/promote_charm.yaml/badge.svg)](https://github.com/canonical/maubot-operator/actions/workflows/promote_charm.yaml)
+[![Discourse Status](https://img.shields.io/discourse/status?server=https%3A%2F%2Fdiscourse.charmhub.io&style=flat&label=CharmHub%20Discourse)](https://discourse.charmhub.io)
 
-# is-charms-template
+# Maubot operator
 
-Charmhub package name: operator-template
-More information: https://charmhub.io/is-charms-template
+A Juju charm deploying and managing [Maubot](https://github.com/maubot/maubot) on Kubernetes.
 
-Describe your charm in one or two sentences.
+Maubot is a plugin-based [Matrix](https://matrix.org/) bot system written in Python.
 
-## Other resources
+## Architecture
 
-<!-- If your charm is documented somewhere else other than Charmhub, provide a link separately. -->
+The charm has the following architecture:
 
-- [Read more](https://example.com)
+```mermaid
+graph TD;
+    user[User] --> ingress[Ingress];
 
-- [Contributing](CONTRIBUTING.md) <!-- or link to other contribution documentation -->
+    subgraph " "
+        direction TB;
+        nginx[NGINX] --> maubot[Maubot];
+    end;
 
-- See the [Juju SDK documentation](https://juju.is/docs/sdk) for more information about developing and improving charms.
+    ingress --> nginx;
+
+    maubot --> postgresql[PostgreSQL Database];
+    maubot --> synapse[Synapse Homeserver];
+```
+
+## Project and community
+
+The Maubot Operator is a member of the Ubuntu family. It's an open source
+project that warmly welcomes community projects, contributions, suggestions,
+fixes and constructive feedback.
+* [Code of conduct](https://ubuntu.com/community/code-of-conduct)
+* [Get support](https://discourse.charmhub.io/)
+* [Join our online chat](https://matrix.to/#/#charmhub-charmdev:ubuntu.com)
+* [Contribute](https://charmhub.io/maubot/docs/contributing)
+* [Getting Started](https://charmhub.io/maubot/docs/getting-started)
+Thinking about using the Maubot Operator for your next project? [Get in touch](https://matrix.to/#/#charmhub-charmdev:ubuntu.com)!