diff --git a/README.md b/README.md index d9d3fc4..f02639f 100644 --- a/README.md +++ b/README.md @@ -20,11 +20,31 @@ Or run from source: python -m grafi_dev.cli ``` +This will automatically open a webpage displaying the Graphite interface. + +![starting_age](/assets/start_page.png) + +The highlighted components show the main interface elements: + +**Header**: Displays the current conversation ID and assistant request ID, with a "New Conversation" button to start fresh sessions. + +**Main Panel**: + +- **Left**: Visual workflow representation showing the execution flow +- **Right**: Detailed information including events, conversation data, and flow history + - **Info Tab**: Shows the detailed information of the workflow or selected components + - **Event Tab**: Shows all the event of the workflow or selected components + - **History Tab**: Shows complete conversation history across all assistant request IDs. + +**Message Input**: Located at the bottom, allows you to send messages directly to the Graphite assistant. + +![demo-gif](/assets/grafi-dev-demo.gif) + ## Feature -* Run any assistant and inspect its workflow in the browser -* Live node execution and event trace -* Interactive web UI for reviewing conversations and workflow details +- Run any assistant and inspect its workflow in the browser +- Live node execution and event trace +- Interactive web UI for reviewing conversations and workflow details ## Development @@ -39,4 +59,4 @@ This launches a FastAPI server with uvicorn and opens the UI. ## Support For questions or fixes, refer to the source code, tests, and issues. -Contributions via pull requests are welcome. \ No newline at end of file +Contributions via pull requests are welcome. diff --git a/assets/grafi-dev-demo.gif b/assets/grafi-dev-demo.gif new file mode 100644 index 0000000..62cf988 Binary files /dev/null and b/assets/grafi-dev-demo.gif differ diff --git a/assets/start_page.png b/assets/start_page.png new file mode 100644 index 0000000..b4a91ee Binary files /dev/null and b/assets/start_page.png differ diff --git a/pyproject.toml b/pyproject.toml index c01cb3a..8c69737 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,7 +3,7 @@ requires = ["setuptools>=68", "wheel"] build-backend = "setuptools.build_meta" [project] -name = "graphite-dev" +name = "grafi-dev" version = "0.0.1" description = "Run a grafi Assistant locally with a live workflow graph & trace viewer" authors = [{ name = "Craig Li", email = "craig@binome.dev" }]