Skip to content

Commit

Permalink
minor change in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tinchoz49 committed Oct 1, 2023
1 parent 66747c9 commit 845065d
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# openapi-box
Generate [TypeBox](https://github.com/sinclairzx81/typebox) types from OpenApi IDL + HTTP client library. It works for TypeScript and plain JavaScript.
Generate [TypeBox](https://github.com/sinclairzx81/typebox) types from OpenApi IDL + End-to-end typesafe HTTP client library.

> It works for TypeScript and JavaScript.
![Tests](https://github.com/geut/openapi-box/actions/workflows/test.yml/badge.svg)
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg?style=flat)](https://standardjs.com)
Expand All @@ -21,7 +23,7 @@ $ npm install @geut/openapi-box @sinclair/typebox
$ openapi-box https://petstore.swagger.io/v2/swagger.json
```

2. Load your schemas into the `HTTP` client:
2. Load your schemas into the End-to-end typesafe `fetch` client:
```js
import { createClient } from './src/client.js'
import { schema } from './schema.js'
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@geut/openapi-box",
"version": "2.2.0",
"description": "Generate TypeBox types from OpenApi IDL + HTTP client library.",
"description": "Generate TypeBox types from OpenApi IDL + End-to-end typesafe HTTP client library.",
"type": "module",
"browser": "./dist/client.cjs",
"main": "./dist/client.cjs",
Expand Down

0 comments on commit 845065d

Please sign in to comment.