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

Commit 1a0e11e

Browse files
committed
Update readme with more information
1 parent 003c2e0 commit 1a0e11e

File tree

2 files changed

+4
-13
lines changed

2 files changed

+4
-13
lines changed

.vscode/settings.json

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1 @@
1-
{
2-
"conventionalCommits.scopes": [
3-
"config",
4-
"Readme"
5-
],
6-
"[yaml]": {
7-
"editor.formatOnSave": false,
8-
},
9-
}
1+
{}

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,19 @@
1-
# Client generator for the Squonk Data Manager API
1+
# Data Manager API JS Client
22

33
[![npm version](https://badge.fury.io/js/%40squonk%2Fdata-manager-client.svg)](https://badge.fury.io/js/%40squonk%2Fdata-manager-client)
44

55
This repo is a NodeJS package that generates a typescript client from an open api specification.
66

77
- Consumes the Squonk Data Manager API
8-
- Generated by [Orval](https://orval.dev)
8+
- Generated from the latest OpenAPI tag with [Orval](https://orval.dev)
99
- Typescript
1010
- Calls made by Axios (this might change)
1111
- Functions to call each API path
1212
- React-Query hooks for use in React applications
13-
- Built with [tsup](https://tsup.egoist.sh/)
1413

1514
## Output
1615

17-
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:
16+
Provides typescript async functions and react hooks. 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:
1817

1918
All types can be imported from the main entry point:
2019
```ts

0 commit comments

Comments
 (0)