Deep dives

Customize README

By default, the README for your SDKs is generated programmatically. You can customize the content and structure of these README files across all of your SDKs by configuring the readme section in generators.yml.

Configuration options

1readme:
2  bannerLink: "https://example.com/banner"
3  introduction: "Welcome to our API"
4  apiReferenceLink: "https://docs.example.com"
5  apiName: "Example Product"
6  disabledSections:
7    - "contributing"
8  defaultEndpoint:
9    method: "POST"
10    path: "/users"
11    stream: false
12  features:
13    authentication:
14      - method: "POST"
15        path: "/auth/login"
16      - "GET /auth/profile"
17    users:
18      - method: "GET"
19        path: "/users"
20      - method: "POST"
21        path: "/users"
string

URL for a banner image or link that appears at the top of the README.

introduction
string

Custom introduction text that appears at the beginning of the README.

string

URL to your external API documentation or reference guide.

apiName
string

Name of the API that appears in the README. Will appear as Your Api Name SDK or Your Api Name API throughout the README. Defaults to organization name if not set.

disabledSections
string[]

Sections to disable in the README. Supported values: "contributing".

defaultEndpoint
ReadmeEndpointSchema

Specifies which endpoint’s code snippet to showcase as the primary example in the README.

features
map<string, list<ReadmeEndpointSchema>>

Organizes endpoints into named feature sections within the README. Each feature creates a dedicated section with example code snippets for the specified endpoints.

Endpoint configuration

Specifies which endpoint’s code snippet to showcase as the primary example in the README.

defaultEndpoint.method
stringRequired

HTTP method of the default endpoint (e.g., GET, POST, PUT, DELETE).

defaultEndpoint.path
stringRequired

Endpoint path for the default example (e.g., /users, /auth/login).

defaultEndpoint.stream
booleanDefaults to false

Whether the endpoint is a streaming endpoint. Defaults to false.

Additional customization

For customization beyond these configuration options, you can manually modify the README and add it to your .fernignore file to prevent it from being overwritten during regeneration.