Skip to content

Commit 6d57faa

Browse files
committed
πŸ”„ Update project branding with new header format
Update header format across README and documentation index Change the branding style from "✨ DroidMind πŸ€–" to "πŸ€– DroidMind 🧠" with consistent formatting in both: - README.md header and layout - docs/index.md main title Also add JSON code example in README for direct IDE integration via uvx
1 parent 4a32e2f commit 6d57faa

File tree

2 files changed

+23
-4
lines changed

2 files changed

+23
-4
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# ✨ DroidMind πŸ€–
2-
31
<div align="center">
42

3+
# πŸ€– DroidMind 🧠
4+
55
<img src="docs/assets/images/logo_neon_glow_icon.png" alt="DroidMind Logo" width="180" />
66

77
[![Python 3.13+](https://img.shields.io/badge/python-3.13+-9D00FF.svg?style=for-the-badge&logo=python&logoColor=white)](https://www.python.org/downloads/)
@@ -39,7 +39,26 @@ For a detailed list of capabilities, see the **[User Manual](docs/user_manual/in
3939

4040
For the fastest way to integrate DroidMind with an MCP-compatible IDE (like Cursor), you can configure it to run DroidMind directly from its GitHub repository using `uvx`. This method **does not require you to manually clone or install DroidMind first**.
4141

42-
Your IDE will be configured to launch DroidMind on demand. Full instructions for this setup are in the **[Quick Start Guide](docs/quickstart.md#1-configure-your-ide-to-run-droidmind-via-uvx)**, which shows the necessary `mcp.json` configuration.
42+
Add the following to your IDE's MCP configuration (e.g., `.cursor/mcp.json` for Cursor):
43+
44+
```json
45+
{
46+
"mcpServers": {
47+
"droidmind": {
48+
"command": "uvx",
49+
"args": [
50+
"--from",
51+
"git+https://github.com/hyperb1iss/droidmind",
52+
"droidmind",
53+
"--transport",
54+
"stdio" // The default and preferred mode for most IDE integrations
55+
]
56+
}
57+
}
58+
}
59+
```
60+
61+
Your IDE will be configured to launch DroidMind on demand. Full instructions for this setup are in the **[Quick Start Guide](docs/quickstart.md#1-configure-your-ide-to-run-droidmind-via-uvx)**.
4362

4463
### Prerequisites
4564

β€Ždocs/index.mdβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ✨ Welcome to DroidMind πŸ€–
1+
# πŸ€– DroidMind 🧠
22

33
<p align="center">
44
<img src="assets/images/logo_neon_glow_icon.png" alt="DroidMind Logo" width="180" />

0 commit comments

Comments
Β (0)