diff --git a/fern/products/sdks/guides/configure-readme.mdx b/fern/products/sdks/guides/configure-readme.mdx index 60e879e1f..6ec687ca4 100644 --- a/fern/products/sdks/guides/configure-readme.mdx +++ b/fern/products/sdks/guides/configure-readme.mdx @@ -3,7 +3,9 @@ title: Customize README description: Guide to configuring the README.md in SDKs --- -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](./sdk-user-features) with usage examples and API details. +Each SDK includes a `README.md` file in its root directory that provides an overview of the SDK and instructions for working with the associated API. + +By default, Fern [generates the README automatically](./sdk-user-features) with usage examples and API details. For a complete example of a generated SDK README, see [Intercom's Python SDK](https://github.com/intercom/python-intercom/blob/3aac991a92cefe34cf437f8f5ca46c97c04c1a6c/README.md). Although each SDK has its own README, the content can be configured globally through the `readme` section in the `generators.yml` file.