Skip to content

Commit 466ddc9

Browse files
committed
update readme
1 parent b4262c6 commit 466ddc9

File tree

1 file changed

+8
-23
lines changed

1 file changed

+8
-23
lines changed

README.md

Lines changed: 8 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ UDX Worker Node.js is a Docker image that provides a ready-to-use Node.js runtim
1414

1515
Requirements: Docker and Node.js (for the CLI).
1616

17-
1. Install the deployment CLI (`@udx/worker-deployment`).
17+
1. Install the deployment CLI ([@udx/worker-deployment](https://www.npmjs.com/package/@udx/worker-deployment)).
1818

1919
```bash
2020
npm install -g @udx/worker-deployment
@@ -32,31 +32,17 @@ worker config
3232
worker run
3333
```
3434

35-
Notes:
36-
37-
- `worker config` generates a `deploy.yml` in your current directory.
38-
- Edit `deploy.yml` with your settings before running.
39-
- Deploy config format and CLI reference: https://github.com/udx/worker/tree/main/docs/deploy/README.md
40-
- `@udx/worker-deployment` on GitHub: https://github.com/udx/worker-deployment
41-
- `@udx/worker-deployment` on npm: https://www.npmjs.com/package/@udx/worker-deployment
42-
4335
## Usage
4436

45-
### Deployment Configuration
46-
47-
- `deploy.yml` is the primary entrypoint for running this image.
48-
- Schema and CLI behavior: https://github.com/udx/worker/tree/main/docs/deploy/README.md
37+
- Deploy configuration: https://github.com/udx/worker-deployment/blob/latest/docs/deploy-config.md
4938

50-
### Runtime Services
39+
- Service configuration: https://github.com/udx/worker/blob/latest/docs/runtime/services.md
5140

52-
- Define services in `.config/worker/services.yaml`.
53-
- Service configuration: https://github.com/udx/worker/tree/main/docs/runtime/services.md
41+
- Runtime config and secrets: https://github.com/udx/worker/blob/latest/docs/runtime/config.md
5442

55-
### Runtime Config and Secrets
43+
### Examples
5644

57-
- Define runtime config in `.config/worker/worker.yaml`.
58-
- Runtime config and auth providers: https://github.com/udx/worker/tree/main/docs/runtime/config.md
59-
- Authorization details: https://github.com/udx/worker/tree/main/docs/authorization.md
45+
- `src/examples/simple-server` is included as a minimal sample.
6046

6147
## Development
6248

@@ -78,10 +64,9 @@ Build defaults for contributors live in `Makefile.variables` (Node.js version, p
7864

7965
## Resources
8066

81-
- Base image docs: https://github.com/udx/worker
82-
- Deployment CLI: https://github.com/udx/worker-deployment
67+
- Base image docs: https://github.com/udx/worker/tree/latest/docs
68+
- Deployment CLI: https://github.com/udx/worker-deployment/tree/latest/docs
8369
- Docker Hub: https://hub.docker.com/r/usabilitydynamics/udx-worker-nodejs
84-
- Product page: https://udx.io/products/udx-worker-nodejs
8570

8671
## Contributing
8772

0 commit comments

Comments
 (0)