From 0f0b6058ea5fa02f1e558779648a0e6597a46735 Mon Sep 17 00:00:00 2001 From: Patrick Chen Date: Fri, 26 Jan 2024 15:05:17 +0800 Subject: [PATCH] feat: restructure readme and add demo video --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d6ee231aa..d09bc5c85 100644 --- a/README.md +++ b/README.md @@ -89,7 +89,7 @@ A simple way to initiate self-hosted TaskingAI community edition is through [Doc - Git installed for cloning the repository. - Python environment (above Python 3.8) for running the client SDK. -### Step-by-Step Guide +### Installation First, clone the TaskingAI (community edition) repository from GitHub. @@ -108,6 +108,16 @@ docker-compose -p taskingai up -d Once the service is up, access the TaskingAI console through your browser with the URL http://localhost:8080. The default username and password are `admin` and `TaskingAI321`. +### TaskingAI UI Console + +[![TaskingAI Console Demo](https://img.youtube.com/vi/4A5uQoawETU/maxresdefault.jpg)](https://youtu.be/4A5uQoawETU) +***

Click the image above for TaskingAI Console Demo Video

*** + + + +### TaskingAI Client SDK + + Once the console is up, you can programmatically interact with the TaskingAI server using the TaskingAI client SDK. Ensure you have Python 3.8 or above installed, and set up a virtual environment (optional but recommended).