Skip to content

Commit f58b773

Browse files
(sdks) Add example link to README guide (#1608)
Co-authored-by: fern-api[bot] <115122769+fern-api[bot]@users.noreply.github.com>
1 parent 5fc7a39 commit f58b773

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

fern/products/sdks/guides/configure-readme.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@ title: Customize README
33
description: Guide to configuring the README.md in SDKs
44
---
55

6-
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.
6+
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.
7+
8+
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).
79

810
Although each SDK has its own README, the content can be configured globally through the `readme` section in the `generators.yml` file.
911

0 commit comments

Comments
 (0)