From 6433cd20d34684ecf2b99585ad8de6b54e4dd789 Mon Sep 17 00:00:00 2001
From: Joshua Mo <102877324+joshua-mo-143@users.noreply.github.com>
Date: Mon, 25 Nov 2024 12:09:18 +0000
Subject: [PATCH] docs: update README

---
 axum/openai/README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/axum/openai/README.md b/axum/openai/README.md
index c2231336..65a6c9ac 100644
--- a/axum/openai/README.md
+++ b/axum/openai/README.md
@@ -1 +1,19 @@
 ## Shuttle AI Playground
+This template enables you to spin up an AI playground in the style of OpenAI.
+
+## Features
+- Frontend (via Next.js)
+- Authentication and sign-ups with cookie-wrapped JWTs
+- Database
+- OpenAI
+
+## How to use
+Before using this, you will need an OpenAI API key.
+
+1) Ensure the OpenAI API key is in your `Secrets.toml` file (see file for syntax if not sure how to use).
+2) Run `npm --prefix frontend install && npm --prefix frontend run build` to build the Next.js frontend.
+3) Use `shuttle run` to run the template locally - or use `shuttle deploy` to deploy!
+
+## Troubleshooting
+- The default port is at 8000. If you are already running something here, you can use `--port` to select a different port.
+- Your OpenAI client may error out if you don't have your OpenAI API key set correctly (should be `OPENAI_API_KEY` in Secrets.toml).