docs: Updated readme with project info

Author: kosz78

Cargo.toml

@@ -16,6 +16,7 @@ license = "MIT"
 homepage = "https://github.com/hcengineering/huly-coder"
 repository = "https://github.com/hcengineering/huly-coder"
 authors = ["Konstantin Zaitsev <[email protected]>"]
+description = "A lightweight autonomous AI coding agent with terminal-based UI, inspired by Codex and Cline."
 
 [dependencies]
 rig-core = { git = "https://github.com/kosz78/rig.git", branch = "mcp", features = [

README.md

@@ -1,6 +1,8 @@
 # Huly Coder
 
-Huly Coder is an AI coding agent that helps you develop software through natural language interaction. It provides a powerful terminal-based interface with a suite of tools for file manipulation, code generation, and project management.
+A lightweight autonomous AI coding agent with terminal-based UI, inspired by Codex and Cline.
+
+![examples/simple.gif](examples/simple.gif)
 
 ## Features
 
@@ -11,12 +13,6 @@ Huly Coder is an AI coding agent that helps you develop software through natural
 - **Multiple LLM Providers**: Support for OpenRouter, LMStudio, and OpenAI
 - **Docker Support**: Easy containerization for portable development environments
 
-## Requirements
-
-- Rust 1.75 or higher
-- OpenRouter API key (or alternative LLM provider credentials)
-- Terminal with Unicode support
-
 ## Configuration
 
 The agent's configuration is stored in `huly-coder.yaml`:
@@ -59,32 +55,6 @@ Create a `huly-coder-local.yaml` file in your `data` directory with overrided co
 cargo xtask run-docker <data_dir> <workspace_dir>
 ```
 
-## Available Tools
-
-Huly Coder comes with a comprehensive set of tools:
-
-- **File Operations**
-  - Read and write files with automatic directory creation
-  - Smart file content replacement with context awareness
-  - Recursive file listing and searching with regex support
-  - File content search with contextual results
-
-- **System Tools**
-  - Execute system commands with safety checks
-  - Interactive command execution support
-  - Background process management
-
-- **Web Tools**
-  - Web search capabilities
-  - URL content fetching with markdown conversion
-  - API integration support
-
-- **Memory System**
-  - Knowledge graph for persistent memory
-  - Entity and relationship management
-  - Context-aware observation storage
-  - Search and retrieval capabilities
-
 ## Contributing
 
 Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

SECURITY.md

@@ -0,0 +1,12 @@
+> [!CAUTION]
+> Huly Coder is a developer agent that can access various systems and execute actions on your local machine on your behalf. Please be aware that developer agents carry unique security risks compared to standard chat-based LLM interactions, as they can run code and perform actions on your computer. Although most foundational models include basic protections against prompt injection, inherent risks remain when using Huly Coder to interact with the internet or process data from untrusted sources. To minimize these risks, consider implementing the following precautions:
+>
+> - Use a dedicated virtual machine or container (Docker/Kubernetes) with restricted privileges. This approach minimizes the risk of local system attacks and prevents unintended access to critical system resources.
+> - Always review code and tests generated by Huly Coder for accuracy and safety.
+> - Avoid sharing sensitive or confidential information with Huly Coder to prevent potential data leakage.
+> - When possible, break down complex instructions into smaller, isolated operations. This reduces the risk of errant commands affecting multiple system components simultaneously and makes it easier to identify abnormal behavior.
+> - Only connect Huly Coder with MCP extensions that you have thoroughly reviewed and trust.
+>
+> In certain circumstances, Huly Coder may execute commands embedded within content, even when these commands conflict with your intended task. We strongly recommend implementing the precautions listed above to mitigate risks from prompt injection attacks. By following these guidelines, you can significantly reduce potential security risks associated with developer agents and better protect your systems and data.
+>
+> For security concerns, please see [privately reporting a security vulnerability](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/privately-reporting-a-security-vulnerability#privately-reporting-a-security-vulnerability) for more information. For assistance or escalation, please contact the [Block Open Source Governance Committee](mailto:[email protected]).