From 5b1ee6ae7953fbb507780620f9aaa6d7626acfbf Mon Sep 17 00:00:00 2001
From: David Andersson <51036209+jdkandersson@users.noreply.github.com>
Date: Wed, 10 Apr 2024 14:51:22 +1000
Subject: [PATCH] update download artefacts version (#6)

* update download artefacts version

* populate long description
---
 .github/workflows/release.yaml |  2 +-
 README.md                      | 23 ++++++++++++++++++++++-
 pyproject.toml                 |  1 +
 3 files changed, 24 insertions(+), 2 deletions(-)

diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
index bea7050..8fb9c85 100644
--- a/.github/workflows/release.yaml
+++ b/.github/workflows/release.yaml
@@ -38,7 +38,7 @@ jobs:
     needs: [ build ]
     steps:
       - name: Download artifacts
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: dist
           path: dist/
diff --git a/README.md b/README.md
index a6a7f02..e92580f 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,22 @@
-# paas-app-charmer
\ No newline at end of file
+# PaaS App Charmer
+
+Easily deploy and operate your flask applications and associated infrastructure,
+such as databases and ingress, using open source tooling. This lets you focus on
+creating applications for your users backed with the confidence that your
+operations are taken care of by world class tooling developed by Canonical, the
+creators of Ubuntu.
+
+Have you ever created an application and then wanted to deploy it for your users
+only to either be forced to use a proprietary public cloud platform or manage
+the deployment and operations yourself? PAAS App Charmer will take your
+application and create an OCI image using rockcraft and operations code using
+charmcraft for you. The full suite of tools is open source so you can see
+exactly how it works and even contribute! After creating the app charm and
+image, you can then deploy your application into any kubernetes cluster using
+juju. Need a database? Using juju you can deploy a range of popular open source
+databases, such as [postgreSQL](https://charmhub.io/postgresql) or
+[MySQL](https://charmhub.io/mysql), and integrate them with your application
+with a few commands. Need an ingress to serve traffic? Use juju to deploy and
+integrate a range of ingress, such as
+[traefik](https://charmhub.io/traefik-k8s), and expose your application to
+external traffic in seconds.
diff --git a/pyproject.toml b/pyproject.toml
index eb0283d..eddb91a 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -4,6 +4,7 @@
 name = "paas-app-charmer"
 version = "1.0.0"
 description = "Companion library for PaaS app charmer."
+readme = "README.md"
 authors = [
     {name = "Canonical IS DevOps team", email="is-devops-team@canonical.com"},
 ]