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

Commit 6585032

Browse files
committed
improvement: readme.md
1 parent 6ff9586 commit 6585032

File tree

1 file changed

+4
-8
lines changed

1 file changed

+4
-8
lines changed

README.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,15 @@
22

33
Tagging a release on this repository will:
44

5-
- Update the [Go SDK GitHub Repo](https://github.com/hookdeck/hookdeck-go-sdk)
5+
- Update the [Go SDK](https://github.com/hookdeck/hookdeck-go-sdk)
66
- _More SDKs to come..._
77

88
## What is in this repository?
99

1010
This repository contains
1111

12-
- Hookdeck's Fern API Definition which lives in the [definition](./fern/api/definition/) folder
13-
- Generators (see [generators.yml](./fern/api/generators.yml))
14-
15-
## What is in the API Definition?
16-
17-
The API Definition contains information about what endpoints, types, and errors are used in the API. The definition is broken into smaller files such as [connection.yml](fern/api/definition/connection.yml) and [event.yml](fern/api/definition/event.yml).
12+
- Hookdeck's Fern API Definition which lives in the [OpenApi](./fern/openapi/) folder
13+
- Generators (see [generators.yml](./fern/generators.yml))
1814

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

@@ -25,7 +21,7 @@ fern check # Checks if the definition is valid
2521

2622
## What are Generators?
2723

28-
Generators read in your API Definition and output files or code (i.e. the TypeScript SDK Generator) and are tracked in [generators.yml](./fern/api/generators.yml).
24+
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).
2925

3026
### Local preview
3127

0 commit comments

Comments
 (0)