docs: change README

README.md

@@ -7,20 +7,42 @@ 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 on Kubernetes.
 
-Describe your charm in one or two sentences.
+Maubot is a plugin-based Matrix bot system written in Python.
 
-## Other resources
+## Architecture
 
-<!-- If your charm is documented somewhere else other than Charmhub, provide a link separately. -->
+```mermaid
+graph TD;
+    user[User] --> ingress[Ingress];
 
-- [Read more](https://example.com)
+    subgraph " "
+        direction TB;
+        nginx[NGINX] --> maubot[Maubot];
+    end;
 
-- [Contributing](CONTRIBUTING.md) <!-- or link to other contribution documentation -->
+    ingress --> nginx;
 
-- See the [Juju SDK documentation](https://juju.is/docs/sdk) for more information about developing and improving charms.
+    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)!

src-docs/charm.py.md

@@ -0,0 +1,77 @@
+<!-- markdownlint-disable -->
+
+<a href="../src/charm.py#L0"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+# <kbd>module</kbd> `charm.py`
+Charm the service. 
+
+Refer to the following post for a quick-start guide that will help you develop a new k8s charm using the Operator Framework: 
+
+https://discourse.charmhub.io/t/4208 
+
+**Global Variables**
+---------------
+- **VALID_LOG_LEVELS**
+
+
+---
+
+## <kbd>class</kbd> `IsCharmsTemplateCharm`
+Charm the service. 
+
+<a href="../src/charm.py#L31"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+### <kbd>function</kbd> `__init__`
+
+```python
+__init__(*args: Any)
+```
+
+Construct. 
+
+
+
+**Args:**
+
+ - <b>`args`</b>:  Arguments passed to the CharmBase parent constructor. 
+
+
+---
+
+#### <kbd>property</kbd> app
+
+Application that this unit is part of. 
+
+---
+
+#### <kbd>property</kbd> charm_dir
+
+Root directory of the charm as it is running. 
+
+---
+
+#### <kbd>property</kbd> config
+
+A mapping containing the charm's config and current values. 
+
+---
+
+#### <kbd>property</kbd> meta
+
+Metadata of this charm. 
+
+---
+
+#### <kbd>property</kbd> model
+
+Shortcut for more simple access the model. 
+
+---
+
+#### <kbd>property</kbd> unit
+
+Unit that this execution is responsible for. 
+
+
+
+