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

Commit cc4ed67

Browse files
committed
chore(docs): update README
1 parent f7af688 commit cc4ed67

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,20 @@
11
# Hookdeck OpenAPI Schema
22

3-
In addition to the standard uses of OpenAPI schema, the Hookdeck OpenAPI schema is used to generate our SDKS:
3+
In addition to the standard uses of OpenAPI schema, the Hookdeck OpenAPI schema is used to generate our SDKS using [Fern](https://www.buildwithfern.com/?ref=hookdeck):
44

55
- [Go SDK](https://github.com/hookdeck/hookdeck-go-sdk)
66
- [TypeScript SDK](https://github.com/hookdeck/hookdeck-typescript-sdk)
7-
- _More SDKs to come..._
87

98
## What is in this repository?
109

1110
This repository contains
1211

13-
- Hookdeck's Fern API Definition which lives in the [OpenApi](./fern/openapi/) folder
14-
- Generators (see [generators.yml](./fern/generators.yml))
12+
- Hookdeck's API Definition which lives in the root directory and contains some Fern specific extensions
13+
- Generators used to generate the SDK (see [generators.yml](./fern/generators.yml))
14+
15+
## About Fern
16+
17+
Fern is used to generate our SDKs from the OpenAPI specification.
1518

1619
In order to make sure that the definition is valid, you can use the Fern CLI.
1720

@@ -20,27 +23,27 @@ npm install -g fern-api # Installs CLI
2023
fern check # Checks if the definition is valid
2124
```
2225

23-
## What are Generators?
26+
### What are Generators?
2427

2528
Generators read in your API Definition and output files or code (i.e. the TypeScript SDK Generator) and are tracked in [generators.yml](./fern/generators.yml).
2629

27-
### Local preview
30+
#### Local preview
2831

2932
You can preview the generated code in the `./local/go/generated/hookdeck-go-sdk` directory by running the following command:
3033

3134
```sh
3235
fern generate --group local
3336
```
3437

35-
## Validating your API Definition
38+
### Validating your API Definition
3639

3740
To validate your API, run:
3841
```sh
3942
npm install -g fern-api # only required once
4043
fern check
4144
```
4245

43-
## Updating your SDKs
46+
### Updating your SDKs
4447

4548
To update your SDKs, run `fern generate`.
4649

0 commit comments

Comments
 (0)