Skip to content

Commit f787e93

Browse files
committed
docs: README quickstart now points at PyPI install (pydcp)
1 parent 1008fe6 commit f787e93

1 file changed

Lines changed: 15 additions & 4 deletions

File tree

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -145,13 +145,24 @@ automatically. The Bridge needs no code change.
145145
## Quickstart
146146

147147
```bash
148+
# As a user — install from PyPI:
149+
pip install "pydcp[mcp,serial]" # or [mcp,serial,mqtt,ble] for all transports
150+
dcp inspect examples/lamp_manifest.yaml # parsed manifest summary
151+
dcp serve examples/lamp_manifest.yaml --simulator
152+
```
153+
154+
```bash
155+
# As a contributor — editable install from source:
156+
git clone https://github.com/device-context-protocol/dcp.git
157+
cd dcp
148158
pip install -e ".[mcp,serial,mqtt,ble,dev]"
149-
python examples/lamp_demo.py # in-process bridge ↔ fake lamp
150-
pytest # all tests
151-
dcp inspect examples/lamp_manifest.yaml # parsed manifest summary
152-
dcp codegen examples/lamp_manifest.yaml -o /tmp/dcp_intents.h
159+
pytest # all 88 tests
160+
python examples/lamp_demo.py # in-process bridge ↔ fake lamp
153161
```
154162

163+
The PyPI package is named `pydcp` (the bare `dcp` is squatted by an
164+
unrelated package). The import name is `dcp`. The protocol name is DCP.
165+
155166
### Run as an MCP server
156167

157168
The reference Bridge ships an MCP server that exposes each DCP intent as an

0 commit comments

Comments
 (0)