docs: add initial project overview

Author: sirrobot01

README.md

@@ -0,0 +1,101 @@
+# MCPulse - MCP Analytics Platform
+
+<div align="center">
+<td>
+    <img src="static/logo.png" alt="MCPulse Dashboard - Light Mode" width="70" />
+</td>
+
+[![Tests](https://img.shields.io/github/actions/workflow/status/sirrobot01/mcpulse/test.yml?branch=main&label=tests&style=flat-square)](https://github.com/sirrobot01/mcpulse/actions/workflows/test.yml)
+[![License](https://img.shields.io/github/license/sirrobot01/mcpulse?style=flat-square)](LICENSE)
+[![Release](https://img.shields.io/github/v/release/sirrobot01/mcpulse?style=flat-square)](https://github.com/sirrobot01/mcpulse/releases)
+[![Go Reference](https://pkg.go.dev/badge/github.com/sirrobot01/mcpulse.svg?style=flat-square)](https://pkg.go.dev/github.com/sirrobot01/mcpulse)
+
+**Open-source analytics and observability platform for Model Context Protocol (MCP) servers**
+
+[Quick Start](#quick-start) • [Documentation](https://docs.mcpulse.io) • [SDKs](#sdks) • [Cloud(coming soon)]() • [License](#license)
+
+</div>
+
+---
+
+**MCPulse** is an open-source, self-hosted analytics and observability platform purpose-built for Model Context Protocol (MCP) servers. Get comprehensive visibility into MCP server usage, performance, errors, and business metrics.
+
+## Screenshots
+
+<div>
+  <table>
+    <tr>
+      <td width="50%" align="center">
+        <img src="static/mcpulse-dark.png" alt="MCPulse Dashboard - Dark Mode" />
+      </td>
+      <td width="50%" align="center">
+        <img src="static/mcpulse-light.png" alt="MCPulse Dashboard - Dark Mode" />
+      </td>
+    </tr>
+    <tr>
+      <td width="50%">
+        <img src="static/server_list.png" alt="MCPulse Dashboard - Light Mode" />
+      </td>
+      <td width="50%">
+        <img src="static/server_detail.png" alt="MCPulse Dashboard - Dark Mode" />
+      </td>
+    </tr>
+  </table>
+</div>
+
+## Quick Start
+
+### Prerequisites
+
+- Docker & Docker Compose
+- OR: Go 1.21+ and Node.js 20+ (for local development)
+
+### Using Docker Compose (Recommended)
+
+1. Clone the repository:
+```bash
+git clone https://github.com/sirrobot01/mcpulse.git
+cd mcpulse
+```
+
+2. Create environment file:
+```bash
+cp .env.example .env
+cp config.yaml.example config.yaml
+# Edit .env and config.yaml to set database credentials and desired ports.
+```
+
+3. Start the services:
+```bash
+docker compose up -d
+```
+
+4. Access the dashboard:
+```
+http://localhost:8080         # Main application
+http://localhost:8080/metrics # Prometheus metrics
+http://localhost:8080/health  # Health check
+```
+
+This starts:
+- **MCPulse Server**: http://localhost:8080
+- **gRPC Server**: localhost:9090(this is used for thr SDKs)
+- **Prometheus Metrics**: http://localhost:8080/metrics
+
+## SDKs
+
+MCPulse provides official SDKs for easy integration with your MCP servers:
+
+- Python: https://github.com/sirrobot01/mcpulse-python
+- Go: https://github.com/sirrobot01/mcpulse-go
+- Node.js/TypeScript: coming soon
+- MCPulse Proxy: coming soon
+
+
+## Documentation
+
+- [User Guide](https://docs.mcpulse.io)
+
+## License
+
+MCPulse is licensed under the [Apache 2.0 License](LICENSE).