docs: add MIT license and enhance README with detailed features and i…

…nstallation instructions

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 2XR
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,15 +1,107 @@
-# mcp-server-zettelkasten
+# Obsidian MCP Tools
 
-To install dependencies:
+Obsidian MCP Tools enhances your Obsidian experience by providing a Model Context Protocol (MCP) server that enables advanced features like semantic search, template execution, and AI-powered tools.
 
-```bash
-bun install
-```
+## Features
+
+- **Semantic Search**: Leverage advanced search capabilities to find relevant notes based on meaning, not just keywords
+- **Template Execution**: Run templates with dynamic parameters and AI-powered content generation
+- **AI Integration**: Connect with Claude Desktop for enhanced functionality
+
+## Prerequisites
+
+### Required
+
+- [Obsidian](https://obsidian.md/) v1.0.0 or higher
+- [Claude Desktop](https://claude.ai/desktop) installed and configured
+- [Local REST API](https://github.com/coddingtonbear/obsidian-local-rest-api) plugin installed and configured with an API key
+
+### Recommended
+
+- [Templater](https://silentvoid13.github.io/Templater/) plugin for enhanced template functionality
+- [Smart Connections](https://smartconnections.app/) plugin for improved semantic search capabilities
+
+## Installation
+
+1. Install the plugin from Obsidian's Community Plugins
+2. Enable the plugin in Obsidian settings
+3. Open the plugin settings
+4. Click "Install Server" to download and configure the MCP server
+
+The plugin will:
+- Download the appropriate MCP server binary for your platform
+- Configure Claude Desktop to use the server
+- Set up necessary permissions and paths
+
+### Installation Locations
+
+- **Server Binary**: {vault}/.obsidian/plugins/obsidian-mcp-tools/bin/
+- **Log Files**:
+  - macOS: ~/Library/Logs/obsidian-mcp-tools
+  - Windows: %APPDATA%\obsidian-mcp-tools\logs
+  - Linux: ~/.local/share/obsidian-mcp-tools/logs
+
+## Configuration
+
+The plugin automatically:
+1. Uses your Local REST API plugin's API key
+2. Configures Claude Desktop to use the MCP server
+3. Sets up appropriate paths and permissions
+
+No manual configuration is required beyond installing prerequisites.
 
-To run:
+## Troubleshooting
 
-```bash
-bun run index.ts
+If you encounter issues:
+
+1. Check the plugin settings to verify:
+   - All required plugins are installed
+   - The server is properly installed
+   - Claude Desktop is configured
+
+2. Review the logs:
+   - Open plugin settings
+   - Click "Open Logs" under Resources
+   - Look for any error messages or warnings
+
+3. Common Issues:
+   - **Server won't start**: Ensure Claude Desktop is running
+   - **Connection errors**: Verify Local REST API plugin is configured
+   - **Permission errors**: Try reinstalling the server
+
+## Development
+
+This project uses a bun workspace structure:
+
+```
+packages/
+├── mcp-server/        # Server implementation
+├── obsidian-plugin/   # Obsidian plugin
+└── shared/           # Shared utilities and types
 ```
 
-This project was created using `bun init` in bun v1.1.39. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
+### Building
+
+1. Install dependencies:
+   ```bash
+   bun install
+   ```
+
+2. Build all packages:
+   ```bash
+   bun run build
+   ```
+
+3. For development:
+   ```bash
+   bun run dev
+   ```
+
+### Requirements
+
+- [bun](https://bun.sh/) v1.0.0 or higher
+- TypeScript 5.0+
+
+## License
+
+[MIT License](LICENSE)