Skip to content

Commit c91929e

Browse files
committed
chore: update README.md
1 parent 108435b commit c91929e

File tree

1 file changed

+8
-21
lines changed

1 file changed

+8
-21
lines changed

README.md

Lines changed: 8 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,14 @@
1-
# Droq Node Template
1+
# DFX Hugging Face Models Node
22

3-
A Python template for building Droqflow nodes.
3+
A Droqflow node providing execution of Hugging Face models.
44

55
## Quick Start
66

77
```bash
8-
git clone git@github.com:droq-ai/dfx-base-node-template-py.git
9-
cd dfx-base-node-template-py
8+
git clone git@github.com:droq-ai/dfx-hf-models-node.git
9+
cd dfx-hf-models-node
1010
uv sync
1111

12-
# Replace src/node/main.py with your code
13-
# Add dependencies: uv add your-package
14-
1512
# Configure node.json with your node information
1613
# Configure environment variables
1714

@@ -22,27 +19,17 @@ PYTHONPATH=src uv run python -m node.main
2219
docker compose up
2320
```
2421

25-
## Next Steps
26-
27-
1. Complete your node development
28-
2. Configure [node.json](docs/node-configuration.md) with your node metadata
29-
3. Register your node [TBD]
30-
31-
32-
33-
34-
3522
## Docker
3623

3724
```bash
3825
# Build
3926
docker build -t your-node:latest .
4027

4128
# Run
42-
docker run -p 8000:8000 \
43-
-e NODE_NAME=my-node \
29+
docker run -p 8006:8006 \
30+
-e NODE_NAME=dfx-hf-models-node \
4431
-e NATS_URL=nats://localhost:4222 \
45-
your-node:latest
32+
droq-ai/dfx-hf-models-node:latest
4633
```
4734

4835
## Development
@@ -53,7 +40,7 @@ PYTHONPATH=src uv run pytest
5340

5441
# Format code
5542
uv run black src/ tests/
56-
uv run ruff check src/ tests/
43+
uv run ruff check --fix src/ tests/
5744

5845
# Add dependencies
5946
uv add package-name

0 commit comments

Comments
 (0)