From 6f0e4396def686590a09941d88bb924bca37f6c8 Mon Sep 17 00:00:00 2001
From: Marius <moprin@cloudbasesolutions.com>
Date: Wed, 10 Mar 2021 12:06:45 +0200
Subject: [PATCH] Update README.md

---
 README.md     |  3 +--
 src/README.md | 18 ++++++++++++++++++
 2 files changed, 19 insertions(+), 2 deletions(-)
 mode change 100644 => 120000 README.md
 create mode 100644 src/README.md

diff --git a/README.md b/README.md
deleted file mode 100644
index f8af3e5..0000000
--- a/README.md
+++ /dev/null
@@ -1,2 +0,0 @@
-# charm-magnum-dashboard
-Juju charm for the Magnum dashboard plugin
diff --git a/README.md b/README.md
new file mode 120000
index 0000000..351df1d
--- /dev/null
+++ b/README.md
@@ -0,0 +1 @@
+src/README.md
\ No newline at end of file
diff --git a/src/README.md b/src/README.md
new file mode 100644
index 0000000..ff8acbc
--- /dev/null
+++ b/src/README.md
@@ -0,0 +1,18 @@
+# Overview
+
+This subordinate charm provides the Magnum Dashboard plugin for use with the OpenStack Dashboard.
+
+# Usage
+
+Example minimal deploy:
+
+    juju deploy magnum-dashboard --config openstack-origin=cloud:bionic-ussuri
+    juju deploy magnum-dashboard
+    juju add-relation \
+        openstack-dashboard:dashboard-plugin magnum-dashboard:dashboard
+
+# Bugs
+
+Please report bugs on [Launchpad](https://bugs.launchpad.net/charm-magnum-dashboard/+filebug).
+
+For general questions please refer to the OpenStack [Charm Guide](https://docs.openstack.org/charm-guide/latest/).
\ No newline at end of file