diff --git a/README.md b/README.md index 2770972..c77d384 100644 --- a/README.md +++ b/README.md @@ -2,21 +2,17 @@ Tagging a release on this repository will update the: -- [Node.js SDK repo](https://github.com/fern-squidex/squidex-node) -- [Java SDK repo](https://github.com/fern-squidex/squidex-java) +- [Node.js SDK repo](https://github.com/squidex/sdk-node) +- [Java SDK repo](https://github.com/squidex/sdk-java) ## What is in this repository? This repository contains -- Squidex's Fern API Definition which lives in the [definition](./fern/api/definition/) folder -- Generators (see [generators.yml](./fern/api/generators.yml)) +- Squidex's OpenAPI specs which lives in the [definition](./fern/openapi/) folder +- Generators (see [generators.yml](./fern/generators.yml)) -## What is in the API Definition? - -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 [{TODO}.yml](fern/api/definition/{TODO}.yml) and [{TODO}.yml](fern/api/definition/{TODO}.yml). - -To make sure that the definition is valid, you can use the Fern CLI. +To make sure that the OpenAPI is valid, you can use the Fern CLI. ```bash npm install -g fern-api # Installs CLI