Initial README, with sections commented out that aren't yet true (#3)

* Remove templated metadata.yaml and populate initial charmcraft yaml so that basic charm can be built

* Updates for lint and unit tests to pass

* Fix integration tests

* Update variable name in integration tests

* We need to define the charm file in integration test

* Update formatting

* Run integration test on juju 3.3 since we're deploying noble

* Switch to canonical k8s which supports juju 3.3

* Use strictly confined microk8s

* Noble isn't supported on 3.3, bump to 3.4

* Match pylibjuju version to juju version for noble support

* Remove explicit reference to noble in charm deploy

* Initial README, with sections commented out that aren't yet true

* Fix typo

* Include link to Penpot

Co-authored-by: Mariyan Dimitrov <[email protected]>

* Fix typo

* Minor phrasing update

---------

Co-authored-by: Mariyan Dimitrov <[email protected]>

README.md

@@ -1,26 +1,48 @@
 <!--
-Avoid using this README file for information that is maintained or published elsewhere, e.g.:
-
-* metadata.yaml > published on Charmhub
-* documentation > published on (or linked to from) Charmhub
-* detailed contribution guide > documentation or CONTRIBUTING.md
-
-Use links instead.
+[![CharmHub Badge](https://charmhub.io/penpot/badge.svg)](https://charmhub.io/penpot)
+[![Publish to edge](https://github.com/canonical/penpot-operator/actions/workflows/publish_charm.yaml/badge.svg)](https://github.com/canonical/penpot-operator/actions/workflows/publish_charm.yaml)
+[![Promote charm](https://github.com/canonical/penpot-operator/actions/workflows/promote_charm.yaml/badge.svg)](https://github.com/canonical/penpot-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
-
-Charmhub package name: operator-template
-More information: https://charmhub.io/is-charms-template
+A Juju charm that deploys and manages [Penpot](https://penpot.app) on Kubernetes. Penpot is the
+web-based open-source design tool that bridges the gap between designers and
+developers.
 
-Describe your charm in one or two sentences.
+<!--
+This charm simplifies initial deployment and "day N" operations of Penpot,
+such as scaling the number of instances, integration with external
+authentication providers, access to S3 for redundant file storage and more. It
+allows for deployment on many different Kubernetes platforms, from [MicroK8s](https://microk8s.io) to
+[Charmed Kubernetes](https://ubuntu.com/kubernetes) to public cloud Kubernetes
+offerings.
+-->
 
-## Other resources
+As such, the charm makes it easy for those looking to take control of their
+own Penpot deployment while keeping operations simple, and gives them the
+freedom to deploy on the Kubernetes platform of their choice.
 
-<!-- If your charm is documented somewhere else other than Charmhub, provide a link separately. -->
+<!--
+For DevOps or SRE teams this charm will make operating Penpot simple and
+straightforward through Juju's clean interface. It will allow easy deployment
+into multiple environments for testing of changes, and supports scaling out for
+enterprise deployments.
+-->
 
-- [Read more](https://example.com)
+## Project and community
 
-- [Contributing](CONTRIBUTING.md) <!-- or link to other contribution documentation -->
+The Penpot 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/)
+<!--
+* [Contribute](https://charmhub.io/penpot/docs/contributing)
+* [Roadmap](https://charmhub.io/penpot/docs/roadmap)
+-->
+Thinking about using Penpot for your next project? [Get in touch](https://chat.charmhub.io/charmhub/channels/charm-dev)!
 
-- See the [Juju SDK documentation](https://juju.is/docs/sdk) for more information about developing and improving charms.
+---
+<!--
+For further details, [see the charm's detailed documentation](https://charmhub.io/penpot/docs).
+-->