Skip to content
This repository was archived by the owner on Nov 23, 2025. It is now read-only.

Commit 003c2e0

Browse files
committed
docs: Update readme to match that this now uses a custom action to do everything
1 parent 89ab9ad commit 003c2e0

File tree

1 file changed

+0
-17
lines changed

1 file changed

+0
-17
lines changed

README.md

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -12,23 +12,6 @@ This repo is a NodeJS package that generates a typescript client from an open ap
1212
- React-Query hooks for use in React applications
1313
- Built with [tsup](https://tsup.egoist.sh/)
1414

15-
## Build
16-
17-
Developed on `Node 16` and `npm 7`
18-
19-
20-
1. Install dependencies with `npm i`
21-
2. Copy a version of the data-manager-api open-api YAML file in to the repo root
22-
3. Generate the client with `npm run build`
23-
4. This can then be deployed with `npm publish`
24-
25-
26-
## Commands
27-
28-
- `npm run orval` will generate the client with Orval
29-
- `npm run build` will generate the client and then bundle it and create a version that can be deployed to npm
30-
- `npm run watch` will watch for changes in the repo and rebundle when changes re detected. It does not regenerate the client automatically.
31-
3215
## Output
3316

3417
The contents published packages depend on the version of the `openapi.yaml` used to generate it. In general though, the package is organised as follows:

0 commit comments

Comments
 (0)