Customize README
Each SDK includes a README.md file in its root directory. This Markdown file provides an overview of the SDK and instructions for working with the associated API. By default, Fern generates the README automatically with usage examples and API details.
Although each SDK has its own README, the content can be configured globally through the readme section in the generators.yml file.
Configuration options
bannerLink
URL for a banner image or link that appears at the top of the README.
introduction
Custom introduction text that appears at the beginning of the README.
apiReferenceLink
URL to your external API documentation or reference guide.
apiName
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.
exampleStyle
Controls whether usage examples show only required parameters (minimal) or all parameters (comprehensive). Currently only supported for Java SDKs.
disabledSections
Sections to disable in the README. Supported values: "contributing".
features
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
HTTP method of the default endpoint (e.g., GET, POST, PUT, DELETE).
defaultEndpoint.path
Endpoint path for the default example (e.g., /users, /auth/login).
defaultEndpoint.stream
Whether the endpoint is a streaming endpoint. Defaults to false.
Custom sections
Define a custom section in the generated README for a specific SDK.
customSections.title
The title of the custom section as it will appear in the README.
customSections.language
The target SDK language for this section. The custom section will only appear in README files generated for the specified language.
customSections.content
The Markdown content of the custom section. You can use template variables in the format {{ variable }} that will be dynamically replaced with values specific to each SDK language when the README is generated.
Available template variables by language:
Additional customization
To go beyond the available configuration options, you can manually edit the README.md file. Then, add it to the .fernignore file to prevent it from being overwritten during regeneration.