From 74ee249dd98779c8c1523480fe5c337cce263c59 Mon Sep 17 00:00:00 2001
From: James Blair <mail@jamesblair.net>
Date: Mon, 4 Dec 2023 20:22:11 +1300
Subject: [PATCH] Add basic readme.

---
 README.md  |  3 ---
 README.org | 33 +++++++++++++++++++++++++++++++++
 2 files changed, 33 insertions(+), 3 deletions(-)
 delete mode 100644 README.md
 create mode 100644 README.org

diff --git a/README.md b/README.md
deleted file mode 100644
index 2b8782a..0000000
--- a/README.md
+++ /dev/null
@@ -1,3 +0,0 @@
-# ocp-app-delivery-workshop
-
-A three hour workshop for teams new to OpenShift that will deliver and support existing applications on the platform.
\ No newline at end of file
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..3a29664
--- /dev/null
+++ b/README.org
@@ -0,0 +1,33 @@
+#+TITLE: OpenShift Application Delivery Workshop
+#+AUTHOR: James Blair
+#+DATE: <2023-12-04 Mon>
+
+This repository contains a basic [[https://nextjs.org/][nextjs]] frontend designed to be exported as a static site and served via [[https://pages.github.com/][github pages]].
+
+The frontend contains a walkthrough for workshop designed to be run over three hours covering basic application delivery, monitoring and security on OpenShift. The workshop content is tailored towards participants that are new to containers and kubernetes and will not be developing applications but will instead be expected to deliver existing applications onto OpenShift.
+
+
+** Local development
+
+To set up a local development environment run the following:
+
+#+begin_src bash
+# Install dependencies
+npm install
+
+# Build and serve the site
+npm run build && npm run serve
+#+end_src
+
+
+** Exporting static site
+
+To export the site to static html to serve for example via github pages, run:
+
+#+begin_src bash
+# Install dependencies
+npm install
+
+# Build and export the site
+npm run build && npm export
+#+end_src