@@ -11,39 +11,43 @@ Shared utilities and components used across DVMCP packages.
1111## Installation & Usage
1212** Prerequisite:** Ensure you have [ Bun] ( https://bun.sh/ ) installed.
1313
14- ### Quick Start with NPX (No Installation)
15- You can run the packages directly using ` npx ` without installing them:
14+ ### Quick Start with Bunx (No Installation)
15+ You can run the packages directly using ` bunx ` without installing them:
1616``` bash
1717# Run the bridge
18- npx @ dvmcp/ bridge
18+ bunx dvmcp- bridge
1919# Run the discovery service
20- npx @ dvmcp/ discovery
20+ bunx dvmcp- discovery
2121```
2222The interactive CLI will guide you through configuration setup on first run.
23+
2324### Global Installation
2425``` bash
2526# Install the packages globally
26- npm install -g @dvmcp/bridge @dvmcp/discovery
27+ bun install -g @dvmcp/bridge @dvmcp/discovery
2728# Run the commands
2829dvmcp-bridge
2930dvmcp-discovery
3031```
32+
3133## Setting Up a Bridge
3234To expose your MCP server as a DVM on Nostr:
33351 . Navigate to the directory where you want to configure the bridge
34- 2 . Run: ` npx @ dvmcp/ bridge`
36+ 2 . Run: ` bunx dvmcp- bridge`
35373 . Follow the interactive setup to configure:
36- - Your MCP server path
37- - Nostr private key (or generate a new one)
38- - Relays to connect to
38+ - Your MCP server path
39+ - Nostr private key (or generate a new one)
40+ - Relays to connect to
39414 . The bridge will start and begin proxying requests between Nostr and your MCP server
42+
4043## Setting Up a Discovery Service
4144To aggregate MCP tools from DVMs:
42451 . Navigate to your desired directory
43- 2 . Run: ` npx @ dvmcp/ discovery`
46+ 2 . Run: ` bunx dvmcp- discovery`
44473 . Follow the setup to configure:
45- - Nostr private key
46- - Relays to monitor
48+ - Nostr private key
49+ - Relays to monitor
50+
4751## Development
4852For contributors to this repository:
4953``` bash
@@ -56,16 +60,4 @@ bun install
5660bun run dev --cwd packages/dvmcp-bridge
5761# Start the discovery service in development mode
5862bun run dev --cwd packages/dvmcp-discovery
59- ```
60- ## Documentation
61- - [ DVMCP Specification] ( ./docs/dvmcp-spec.md )
62- - [ Bridge Package] ( ./packages/dvmcp-bridge/README.md )
63- - [ Discovery Package] ( ./packages/dvmcp-discovery/README.md )
64- - [ Commons Package] ( ./packages/dvmcp-commons/README.md )
65- ## Contributing
66- Contributions are welcome! Please feel free to submit pull requests or create issues.
67- ## License
68- [ MIT License] ( LICENSE )
69- ## Related Projects
70- - [ Model Context Protocol] ( https://modelcontextprotocol.io )
71- - [ Nostr Protocol] ( https://github.com/nostr-protocol/nips )
63+ ```
0 commit comments