Skip to content

Commit

Permalink
fix(docs): update readme (#4685)
Browse files Browse the repository at this point in the history 
fix readme

Co-authored-by: fern-bot <info@buildwithfern.com>
  • Loading branch information
@chdeskur @fern-support
chdeskur and fern-support authored Sep 18, 2024
1 parent aab8087 commit 9e7de94
Showing 1 changed file with 18 additions and 19 deletions.
37 changes: 18 additions & 19 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,45 +76,45 @@ Postman Collections, Server boilerplate, etc.). To add a generator run `fern add

| Generator ID | Latest Version | Changelog | Entrypoint |
| -------------------------------------- | -------------- | ------------------------------------------------------------ | ------------------------------------------------------------------------------- |
| `fernapi/fern-typescript-node-sdk` | [![Typescript Generator Version](https://img.shields.io/docker/v/fernapi/fern-typescript-node-sdk)](./generators/typescript/sdk/VERSION) | [CHANGELOG.md](./generators/typescript/sdk/CHANGELOG.md) | [cli.ts](./generators/typescript/sdk/cli/src/nodeCli.ts) |
| `fernapi/fern-python-sdk` | [![Python Generator Version](https://img.shields.io/docker/v/fernapi/fern-python-sdk)](./generators/python/sdk/VERSION) | [CHANGELOG.md](./generators/python/sdk/CHANGELOG.md) | [cli.py](./generators/python/src/fern_python/generators/sdk/cli.py) |
| `fernapi/fern-java-sdk` | [![Java Generator Version](https://img.shields.io/docker/v/fernapi/fern-java-sdk)](./generators/java/sdk/VERSION) | [CHANGELOG.md](./generators/java/sdk/CHANGELOG.md) | [Cli.java](./generators/java/sdk/src/main/java/com/fern/java/client/Cli.java) |
| `fernapi/fern-ruby-sdk` | [![Ruby Generator Version](https://img.shields.io/docker/v/fernapi/fern-ruby-sdk)](./generators/ruby/sdk/VERSION) | [CHANGELOG.md](./generators/ruby/sdk/CHANGELOG.md) | [cli.ts](./generators/ruby/sdk/src/cli.ts) |
| `fernapi/fern-go-sdk` | [![Go Generator Version](https://img.shields.io/docker/v/fernapi/fern-go-sdk)](./generators/go/sdk/VERSION) | [CHANGELOG.md](./generators/go/sdk/CHANGELOG.md) | [main.go](./generators/go/cmd/fern-go-sdk/main.go) |
| `fernapi/fern-csharp-sdk` | [![C# Generator Version](https://img.shields.io/docker/v/fernapi/fern-csharp-sdk)](./generators/csharp/sdk/VERSION) | [CHANGELOG.md](./generators/csharp/sdk/CHANGELOG.md) | [cli.ts](./generators/csharp/sdk/src/cli.ts) |
| `fernapi/fern-typescript-node-sdk` | ![Typescript Generator Version](https://img.shields.io/docker/v/fernapi/fern-typescript-node-sdk) | [CHANGELOG.md](./generators/typescript/sdk/CHANGELOG.md) | [cli.ts](./generators/typescript/sdk/cli/src/nodeCli.ts) |
| `fernapi/fern-python-sdk` | ![Python Generator Version](https://img.shields.io/docker/v/fernapi/fern-python-sdk) | [CHANGELOG.md](./generators/python/sdk/CHANGELOG.md) | [cli.py](./generators/python/src/fern_python/generators/sdk/cli.py) |
| `fernapi/fern-java-sdk` | ![Java Generator Version](https://img.shields.io/docker/v/fernapi/fern-java-sdk) | | [Cli.java](./generators/java/sdk/src/main/java/com/fern/java/client/Cli.java) |
| `fernapi/fern-ruby-sdk` | ![Ruby Generator Version](https://img.shields.io/docker/v/fernapi/fern-ruby-sdk) | | [cli.ts](./generators/ruby/sdk/src/cli.ts) |
| `fernapi/fern-go-sdk` | ![Go Generator Version](https://img.shields.io/docker/v/fernapi/fern-go-sdk) | | [main.go](./generators/go/cmd/fern-go-sdk/main.go) |
| `fernapi/fern-csharp-sdk` | ![C# Generator Version](https://img.shields.io/docker/v/fernapi/fern-csharp-sdk) | | [cli.ts](./generators/csharp/sdk/src/cli.ts) |

### Server-side Generators

Fern's server-side generators output boilerplate application code (models and networking logic). This is intended for spec-first or API-first developers,
who write their API definition (as an OpenAPI spec or Fern definition) and want to generate backend code.
Fern's server-side generators output boilerplate application code (models and networking logic). This is intended for spec-first or API-first developers, who write their API definition (as an OpenAPI spec or Fern definition) and want to generate backend code.

| Generator ID | Latest Version | Changelog | Entrypoint |
| ----------------------------- | -------------- | ------------------------------------------------------------ | -------------------------------------------------------------------------------- |
| `fernapi/fern-typescript-express` | [![Typescript Express Server Generator Version](https://img.shields.io/docker/v/fernapi/fern-typescript-express)](./generators/typescript/express/VERSION) | [CHANGELOG.md](./generators/typescript/express/CHANGELOG.md) | [cli.ts](./generators/typescript/express/cli/src/cli.ts) |
| `fernapi/fern-fastapi-server` | [![Python FastAPI Server Generator Version](https://img.shields.io/docker/v/fernapi/fern-fastapi-server)](./generators/python/fastapi/VERSION) | [CHANGELOG.md](./generators/python/fastapi/CHANGELOG.md) | [cli.py](./generators/python/src/fern_python/generators/sdk/cli.py) |
| `fernapi/fern-java-spring` | [![Java Spring Server Generator Version](https://img.shields.io/docker/v/fernapi/fern-java-spring)](./generators/java/spring/VERSION) | [CHANGELOG.md](./generators/java/spring/CHANGELOG.md) | [Cli.java](./generators/java/spring/src/main/java/com/fern/java/spring/Cli.java) |
| `fernapi/fern-typescript-express` | ![Typescript Express Server Generator Version](https://img.shields.io/docker/v/fernapi/fern-typescript-express) | | [cli.ts](./generators/typescript/express/cli/src/cli.ts) |
| `fernapi/fern-fastapi-server` | ![Python FastAPI Server Generator Version](https://img.shields.io/docker/v/fernapi/fern-fastapi-server) | | [cli.py](./generators/python/src/fern_python/generators/sdk/cli.py) |
| `fernapi/fern-java-spring` | ![Java Spring Server Generator Version](https://img.shields.io/docker/v/fernapi/fern-java-spring) | | [Cli.java](./generators/java/spring/src/main/java/com/fern/java/spring/Cli.java) |

### Model Generators

Fern's model generators will output schemas or types defined in your OpenAPI spec or Fern Definition.

| Generator ID | Latest Version | Changelog | Entrypoint |
| ----------------------------- | -------------- | --------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `fernapi/fern-pydantic-model` | [![Pydantic Model Generator Version](https://img.shields.io/docker/v/fernapi/fern-pydantic-model)](./generators/python/pydantic/VERSION) | [CHANGELOG.md](./generators/python/pydantic/CHANGELOG.md) | [cli.py](./generators/python/src/fern_python/generators/sdk/cli.py) |
| `fernapi/java-model` | [![Java Model Generator Version](https://img.shields.io/docker/v/fernapi/java-model)](./generators/java/model/VERSION) | [CHANGELOG.md](./generators/java/model/CHANGELOG.md) | [Cli.java](./generators/java/sdk/src/main/java/com/fern/java/client/Cli.java) |
| `fernapi/fern-ruby-model` | [![Ruby Model Generator Version](https://img.shields.io/docker/v/fernapi/fern-ruby-model)](./generators/ruby/model/VERSION)| [CHANGELOG.md](./generators/ruby/model/CHANGELOG.md) | [cli.ts](./generators/ruby/model/src/cli.ts) |
| `fernapi/fern-go-model` | [![Go Model Generator Version](https://img.shields.io/docker/v/fernapi/fern-go-model)](./generators/go/model/VERSION)| [CHANGELOG.md](./generators/go/model/CHANGELOG.md) | [main.go](./generators/go/cmd/fern-go-model/main.go) |
| `fernapi/fern-pydantic-model` | ![Pydantic Model Generator Version](https://img.shields.io/docker/v/fernapi/fern-pydantic-model) | | [cli.py](./generators/python/src/fern_python/generators/sdk/cli.py) |
| `fernapi/java-model` | ![Java Model Generator Version](https://img.shields.io/docker/v/fernapi/java-model) | | [Cli.java](./generators/java/sdk/src/main/java/com/fern/java/client/Cli.java) |
| `fernapi/fern-ruby-model` | ![Ruby Model Generator Version](https://img.shields.io/docker/v/fernapi/fern-ruby-model) | | [cli.ts](./generators/ruby/model/src/cli.ts) |
| `fernapi/fern-go-model` | ![Go Model Generator Version](https://img.shields.io/docker/v/fernapi/fern-go-model) | | [main.go](./generators/go/cmd/fern-go-model/main.go) |

### Spec Generators

Fern's spec generators can output an OpenAPI spec or a Postman collection.

> **Note**: The OpenAPI spec generator is primarly intended for Fern Definition users. This prevents lock-in so that one can always export to OpenAPI.
> **Note**: The OpenAPI spec generator is primarily intended for Fern Definition users. This prevents lock-in so that one can always export to OpenAPI.
| Generator ID | Latest Version | Changelog | Entrypoint |
| ---------------------- | -------------- | ------------------------------------------------- | ------------------------------------------ |
| `fernapi/fern-openapi` | [![OpenAPI Generator Version](https://img.shields.io/docker/v/fernapi/fern-openapi)](./generators/openapi/VERSION) | [CHANGELOG.md](./generators/openapi/CHANGELOG.md) | [cli.ts](./generators/openapi/src/cli.ts) |
| `fernapi/fern-postman` | [![Postman Generator Version](https://img.shields.io/docker/v/fernapi/fern-postman)](./generators/postman/VERSION) | [CHANGELOG.md](./generators/postman/CHANGELOG.md) | [cli.ts](./generators/postman/src/cli.ts) |
| `fernapi/fern-openapi` | ![OpenAPI Generator Version](https://img.shields.io/docker/v/fernapi/fern-openapi) | [CHANGELOG.md](./generators/openapi/CHANGELOG.md) | [cli.ts](./generators/openapi/src/cli.ts) |
| `fernapi/fern-postman` | ![Postman Generator Version](https://img.shields.io/docker/v/fernapi/fern-postman) | | [cli.ts](./generators/postman/src/cli.ts) |


## 🌿 CLI Commands

Expand Down Expand Up @@ -217,7 +217,6 @@ Checkout open source projects that are using Fern Definitions:
- [Metriport](https://github.com/metriport/metriport/tree/develop/fern/definition)
- [Rivet](https://github.com/rivet-gg/rivet/tree/main/fern/definition)
- [Revert](https://github.com/revertinc/revert/tree/main/fern/definition)
## Inspiration
Expand Down

0 comments on commit 9e7de94

Please sign in to comment.