From 51884602a779310dc443d567327ace83c3216b84 Mon Sep 17 00:00:00 2001
From: Alan Nichol <alan@rasa.com>
Date: Mon, 29 Jul 2024 17:16:43 +0200
Subject: [PATCH] Update README.md

---
 README.md | 44 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)

diff --git a/README.md b/README.md
index c8f7329..f68db0f 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,46 @@
 # codespaces-quickstart
 Get started with Rasa Pro in the browser using GitHub Codespaces.
+
+### Steps
+
+1. **Create a Codespace:**
+   - Click on the green "Code" button on this page, then scroll down to "Codespaces".
+   - Click on "Create codespace on main".
+
+2. **Set Up Environment:**
+   - Open the `.env` file from this repo and add the required keys to that file.
+     ```
+     export RASA_PRO_LICENSE='your_rasa_pro_license_key_here'
+     export OPENAI_API_KEY='your_openai_api_key_here'
+     ```
+   - Set these environment variables by running `source .venv/bin/activate` 
+     ```
+     source .env
+     ```
+   - Activate your python environment by running 
+
+3. **Initialize a New Project:**
+   - In the terminal, run:
+     ```
+     rasa init --template tutorial
+     ```
+     and follow the instructions.
+
+4. **Train the Model:**
+   - In the terminal, run:
+     ```
+     rasa train
+     ```
+
+5. **Talk to your Bot:**
+   - In the terminal, run
+     ```
+     rasa inspect
+     ```
+     GitHub will show a notification, click on the green button to view the inspector where you can chat with your assistant.
+
+6. **Run Custom Actions:**
+   If your bot uses custom actions, you will need to run an action server. To do this:
+   - Create a secnd terminal window in the codespace
+   - load the env vars and activate your virtual environment: `source .env && source .venv/bin/activate`
+   - start the action server by running `rasa run actions`