From a2af89e61f444834d115b8ef6ca9bc3289632ffb Mon Sep 17 00:00:00 2001 From: Luxferre Date: Sat, 21 Mar 2026 16:32:30 +0200 Subject: [PATCH] updated the readme --- README.md | 19 +++++++------------ 1 file changed, 7 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 303ddbc..cce4cbb 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Sidekick -Sidekick is a production-ready agentic framework written in Go 1.25. It provides a robust architecture for building AI assistants with hierarchical orchestration, native Model Context Protocol (MCP) integration, and a rich terminal user interface (TUI). +Sidekick is a versatile agentic framework written in Go 1.25. It provides a robust architecture for building AI assistants with hierarchical orchestration, native Model Context Protocol (MCP) integration, and a rich terminal user interface (TUI). ## Features @@ -108,6 +108,10 @@ user's request and delegate tasks accordingly. ```bash ./bin/sidekick-tui ``` +* **Input:** Type your messages at the bottom prompt. +* **Send:** Press `Enter` to send a message. +* **Quit:** Press `ctrl+c` to exit. +* **Scrolling:** Use the mouse wheel or arrow keys to scroll through the conversation history. ### Running the Sidekick MCP Server @@ -129,11 +133,6 @@ port = 8080 # for sse/http The server provides a `query` tool that routes requests to your coordinator agent, maintaining conversation history if provided. -* **Input:** Type your messages at the bottom prompt. -* **Send:** Press `Enter` to send a message. -* **Quit:** Press `ctrl+c` to exit. -* **Scrolling:** Use the mouse wheel or arrow keys to scroll through the conversation history. - ### Using the Framework Programmatically ```go @@ -180,10 +179,6 @@ func main() { } ``` -## Contributing +## Credits -Contributions are welcome! Please ensure that all code adheres to the project's strict coding standards defined in `AGENTS.md` (e.g., 2-space indentation, max 112 characters per line, double-quoted strings). - -## License - -MIT +Created by Luxferre in 2026, released into public domain with no warranties.