From ecb0850d7a885f4bd5405862258e9ac363b41868 Mon Sep 17 00:00:00 2001
From: Raul Zamora <raul.zamora@canonical.com>
Date: Thu, 20 Jun 2024 09:33:46 +0200
Subject: [PATCH] add README

---
 README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 52 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2e28576
--- /dev/null
+++ b/README.md
@@ -0,0 +1,52 @@
+# Charmed Karapace ROCK
+
+[![Container Registry](https://img.shields.io/badge/Container%20Registry-published-blue)](https://github.com/canonical/charmed-karapace-rock/pkgs/container/charmed-karapace)
+[![Release](https://github.com/canonical/charmed-karapace-rock/actions/workflows/publish.yaml/badge.svg)](https://github.com/canonical/charmed-karapace-rock/actions/workflows/publish.yaml)
+
+This repository contains the packaging metadata for creating a Charmed Karapace ROCK.
+
+For more information on ROCKs, visit the [rockcraft Github](https://github.com/canonical/rockcraft). 
+
+## Building the ROCK
+The steps outlined below are based on the assumption that you are building the ROCK with the latest LTS of Ubuntu.  
+If you are using another version of Ubuntu or another operating system, the process may be different. 
+To avoid any issue with other operating systems you can simply build the image with [multipass](https://multipass.run/):
+```bash
+sudo snap install multipass
+multipass launch 22.04 -n rock-dev
+multipass shell rock-dev
+```
+
+### Clone Repository
+```bash
+git clone https://github.com/canonical/charmed-karapace-rock.git
+cd charmed-karapace-rock
+```
+
+### Installing Prerequisites
+```bash
+sudo snap install rockcraft --edge --classic
+sudo snap install docker
+sudo snap install lxd
+sudo snap install skopeo --edge --devmode
+```
+
+### Configuring Prerequisites
+```bash
+sudo usermod -aG docker $USER 
+sudo lxd init --auto
+```
+*_NOTE:_* You will need to open a new shell for the group change to take effect (i.e. `su - $USER`)
+
+### Packing and Running the ROCK
+```bash
+rockcraft pack
+sudo skopeo --insecure-policy copy oci-archive:charmed-karapace*.rock docker-daemon:<username>/charmed-karapace:<tag>
+docker run --rm -it <username>/charmed-karapace:<tag>
+```
+
+## License
+The Charmed Karapace ROCK is free software, distributed under the Apache
+Software License, version 2.0. See
+[LICENSE](https://github.com/canonical/charmed-karapace-rock/blob/main/LICENSE)
+for more information.