From 19ef6270cdfd01f19e1b66b83fe74219b47ff6b1 Mon Sep 17 00:00:00 2001
From: Tobias Sterbak <github@tobiassterbak.com>
Date: Wed, 3 Jul 2024 10:35:34 +0200
Subject: [PATCH] Update website, readme and examples

---
 README.md          |  4 ++--
 docs/index.md      |  6 +++---
 docs/tutorial.md   |  2 +-
 examples/README.md | 33 +++++++++++++++++++++++++++++++++
 4 files changed, 39 insertions(+), 6 deletions(-)
 create mode 100644 examples/README.md

diff --git a/README.md b/README.md
index 8ed2f55..8cce3f0 100644
--- a/README.md
+++ b/README.md
@@ -43,9 +43,9 @@ To use promptmage, run the following command:
 promptmage run <path-to-flow>
 ```
 
-This will start the promptmage server and run the flow at the given path. You can now access the promptmage interface at `http://localhost:8000`.
+This will start the promptmage server and run the flow at the given path. You can now access the promptmage interface at `http://localhost:8000/gui/`.
 
-Have a look at the examples in the [examples](examples) folder to see how to use promptmage in your application or workflow.
+Have a look at the examples in the [examples](https://github.com/tsterbak/promptmage/tree/main/examples) folder to see how to use promptmage in your application or workflow.
 
 
 ## Use with Docker
diff --git a/docs/index.md b/docs/index.md
index 2f976a3..2396d04 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -40,12 +40,12 @@ pip install promptmage
 To use promptmage, run the following command:
 
 ```bash
-promptmage run <path-to-flow>
+promptmage run <path-to-flow>.py
 ```
 
-This will start the promptmage server and run the flow at the given path. You can now access the promptmage interface at `http://localhost:8000`.
+This will start the promptmage server and run the flow at the given path. You can now access the promptmage interface at `http://localhost:8000/gui/`.
 
-Have a look at the examples in the [examples](examples) folder to see how to use promptmage in your application or workflow.
+Have a look at the examples in the [examples](https://github.com/tsterbak/promptmage/tree/main/examples) folder to see how to use promptmage in your application or workflow.
 
 
 ## Development
diff --git a/docs/tutorial.md b/docs/tutorial.md
index 397765f..63bb0dc 100644
--- a/docs/tutorial.md
+++ b/docs/tutorial.md
@@ -60,7 +60,7 @@ You don't need to worry about saving the prompts and data, PromptMage will take
 Now you can run the application by 
 
 ```bash
-promptmage summarizer.py
+promptmage run summarizer.py
 ```
 
 This will start the PromptMage web UI, where you can interact with the prompts and run and see the output of the steps.
\ No newline at end of file
diff --git a/examples/README.md b/examples/README.md
new file mode 100644
index 0000000..7f6601d
--- /dev/null
+++ b/examples/README.md
@@ -0,0 +1,33 @@
+# PromptMage Examples
+
+This repository contains examples for using PromptMage in your application or workflow.
+
+## Examples
+
+- Article Summarizer: A simple multi-step LLM application that extracts facts from a given text and summarizes the text using the extracted facts. [View Example](https://github.com/tsterbak/promptmage/blob/main/examples/summarize_article_by_facts.py)
+
+- Answer questions about YouTube videos: A multi-step LLM application that extracts information from a YouTube video and answers questions about the video. [View Example](https://github.com/tsterbak/promptmage/blob/main/examples/youtube_understanding.py)
+
+
+## Getting Started
+
+### Installation
+
+Install the dependencies from the pyproject.toml file.
+
+```bash
+poetry install
+```
+
+### Usage
+
+To use PromptMage, run the following command:
+
+```bash
+poetry run promptmage run <path-to-flow>.py
+```
+
+
+## Docker Example
+
+You can find an usage example with docker here: [Docker example](https://github.com/tsterbak/promptmage/tree/main/examples/docker)
\ No newline at end of file