Skip to content

Commit

Permalink
feat: restructure readme and add demo video
Browse files Browse the repository at this point in the history
  • Loading branch information
DynamesC authored and jameszyao committed Jan 26, 2024
1 parent effca33 commit 5c357a6
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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)
***<p style="text-align: center; font-size: small; ">Click the image above for TaskingAI Console Demo Video</p>***



### 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).
Expand Down

0 comments on commit 5c357a6

Please sign in to comment.