Skip to content

Commit b9bcb95

Browse files
committed
Refactor documentation
1 parent 8d627bd commit b9bcb95

2 files changed

Lines changed: 32 additions & 88 deletions

File tree

README.md

Lines changed: 12 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ MCP Pointer is a Chrome extension + MCP server that allows you to point at any D
1515

1616
## 🚀 Quick Start
1717

18-
> **For Testers & Contributors:** See [SETUP_FOR_TESTERS.md](./SETUP_FOR_TESTERS.md) for development setup instructions.
18+
> **For Contributors:** See [CONTRIBUTING.md](./CONTRIBUTING.md) for development setup and contribution guidelines.
19+
> **For Testers:** See [SETUP_FOR_TESTERS.md](./SETUP_FOR_TESTERS.md) for testing unreleased versions.
1920
2021
### 1. Install the MCP Server
2122

@@ -90,72 +91,6 @@ git push origin v0.1.0
9091
# Or use GitHub's release UI
9192
```
9293

93-
## 🛠 Development Setup
94-
95-
```bash
96-
# Clone repository
97-
git clone https://github.com/elieteyssedou/mcp-pointer.git
98-
cd mcp-pointer
99-
100-
# Install dependencies
101-
pnpm install
102-
```
103-
104-
### Chrome Extension Development
105-
106-
1. **Build extension in development mode**:
107-
```bash
108-
cd packages/chrome-extension
109-
pnpm dev # Builds to dev/ directory with logging enabled and source maps
110-
```
111-
112-
2. **Load extension in Chrome**:
113-
- Open Chrome → Extensions → Developer mode → Load unpacked
114-
- Select `packages/chrome-extension/dev/` folder
115-
- The extension will appear in your browser
116-
117-
3. **Making changes**:
118-
- Files are watched automatically in dev mode
119-
- Refresh the extension in Chrome Extensions page after changes
120-
- Check browser console for development logs
121-
122-
4. **Development vs Production**:
123-
- **Dev build** (`pnpm dev`) → `dev/` folder, includes logging and source maps
124-
- **Production build** (`pnpm build`) → `dist/` folder, minified, no logs
125-
126-
### MCP Server Development
127-
128-
1. **Run MCP server in watch mode**:
129-
```bash
130-
cd packages/server
131-
pnpm dev # Starts server and restarts on file changes
132-
```
133-
134-
2. **Test server locally**:
135-
```bash
136-
# In a separate terminal
137-
node dist/cli.cjs --help # Test the built CLI
138-
```
139-
140-
3. **Configure for development**:
141-
```bash
142-
pnpm -C packages/server configure # Auto-configure Claude Code
143-
```
144-
145-
### Development Commands
146-
147-
```bash
148-
# Build everything for production
149-
pnpm build
150-
151-
# Run linting and type checking
152-
pnpm lint
153-
pnpm typecheck
154-
155-
# Clean all build outputs
156-
pnpm -C packages/chrome-extension clean
157-
pnpm -C packages/server clean
158-
```
15994

16095
## 🏗 Project Structure
16196

@@ -268,11 +203,18 @@ MIT License - see LICENSE file for details
268203

269204
## 🤝 Contributing
270205

206+
We welcome contributions! Please see our [CONTRIBUTING.md](./CONTRIBUTING.md) guide for:
207+
208+
- Development setup instructions
209+
- Code style guidelines
210+
- Testing requirements
211+
- Pull request process
212+
213+
**Quick start for contributors:**
271214
1. Fork the repository
272-
2. Create a feature branch
215+
2. Follow the setup guide in [CONTRIBUTING.md](./CONTRIBUTING.md)
273216
3. Make your changes
274-
4. Add tests if applicable
275-
5. Submit a pull request
217+
4. Submit a pull request
276218

277219
---
278220

SETUP_FOR_TESTERS.md

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# 🧪 Setup Guide for Testers & Contributors
22

3-
This guide helps you set up AI Glasses for testing or development without waiting for official npm releases.
3+
This guide helps you set up MCP Pointer for testing unreleased versions without waiting for official npm releases.
4+
5+
> **For Development & Contributing:** See [CONTRIBUTING.md](./CONTRIBUTING.md) for comprehensive development setup, code guidelines, and contribution process.
46
57
## 📋 Prerequisites
68

@@ -14,8 +16,8 @@ This guide helps you set up AI Glasses for testing or development without waitin
1416

1517
```bash
1618
# Clone the repository
17-
git clone <repository-url>
18-
cd tuba_mcp
19+
git clone https://github.com/elieteyssedou/mcp-pointer
20+
cd mcp-pointer
1921

2022
# Install all dependencies
2123
pnpm install
@@ -24,7 +26,7 @@ pnpm install
2426
pnpm -C packages/server link:global
2527
```
2628

27-
This creates a global `glasses` command that points to your local build.
29+
This creates a global `mcp-pointer` command that points to your local build.
2830

2931
### 2. Install Chrome Extension (Developer Mode)
3032

@@ -39,11 +41,11 @@ pnpm -C packages/chrome-extension build
3941
1. Open Chrome → Settings → Extensions → Developer mode (toggle ON)
4042
2. Click "Load unpacked"
4143
3. Select the `packages/chrome-extension/dist/` folder
42-
4. The AI Glasses extension should appear in your extensions list
44+
4. The MCP Pointer extension should appear in your extensions list
4345

4446
### 3. Configure Your Working Project
4547

46-
Navigate to any project where you want to use AI Glasses:
48+
Navigate to any project where you want to use MCP Pointer:
4749

4850
```bash
4951
cd /path/to/your/frontend-project
@@ -58,18 +60,18 @@ The `.mcp.json` will look like:
5860
```json
5961
{
6062
"mcpServers": {
61-
"@glasses/mcp": {
62-
"command": "glasses",
63-
"args": ["wear"],
63+
"@mcp-pointer/server": {
64+
"command": "mcp-pointer",
65+
"args": ["start"],
6466
"env": {
65-
"GLASSES_PORT": "7007"
67+
"MCP_POINTER_PORT": "7007"
6668
}
6769
}
6870
}
6971
}
7072
```
7173

72-
### 4. Start Using AI Glasses
74+
### 4. Start Using MCP Pointer
7375

7476
```bash
7577
# In your working project, start the MCP server
@@ -85,7 +87,7 @@ Now you can:
8587

8688
## 🔄 Making Changes
8789

88-
When you make changes to the AI Glasses code:
90+
When you make changes to the MCP Pointer code:
8991

9092
```bash
9193
# For MCP server changes
@@ -100,7 +102,7 @@ pnpm -C packages/chrome-extension build
100102

101103
```bash
102104
# Remove the global link
103-
npm unlink -g @glasses/mcp
105+
npm unlink -g @mcp-pointer/server
104106

105107
# Remove from your projects
106108
rm .mcp.json # In each project that used it
@@ -111,7 +113,7 @@ rm .mcp.json # In each project that used it
111113
### MCP Server Issues
112114

113115
```bash
114-
# Check if glasses command is available
116+
# Check if mcp-pointer command is available
115117
mcp-pointer --help
116118

117119
# Test server startup
@@ -145,16 +147,16 @@ mcp-pointer start --log-level debug
145147
- Check that `.mcp.json` exists in your project root
146148
- Verify MCP server is running
147149

148-
2. **"Command not found: glasses":**
150+
2. **"Command not found: mcp-pointer":**
149151
- Run `npm link` again in `packages/server/` directory
150152
- Check your `PATH` includes npm global binaries
151153

152154
## 📁 Project Structure
153155

154156
```
155-
tuba_mcp/
157+
mcp-pointer/
156158
├── packages/
157-
│ ├── mcp/ # MCP Server
159+
│ ├── server/ # MCP Server
158160
│ │ ├── dist/cli.cjs # Built CLI (created by pnpm build)
159161
│ │ └── src/ # Source code
160162
│ ├── chrome-extension/ # Chrome Extension
@@ -185,4 +187,4 @@ tuba_mcp/
185187

186188
**Questions or issues?** Check the main README.md or create an issue in the repository.
187189

188-
**Happy testing! 👓**
190+
**Happy testing! 👆**

0 commit comments

Comments
 (0)