Skip to content

Commit ce586a6

Browse files
Update configure-readme.mdx
1 parent 35159ef commit ce586a6

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed
Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,19 @@
11
---
22
title: Customize README
3-
description: Guide to configuring the README in your SDK
3+
description: Guide to configuring the README.md in SDKs
44
---
55

6-
By default, the `README.md` for your SDKs is [generated programmatically](./sdk-user-features) and contains information about how your users can interact with your API.
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.
77

8-
Each SDK has its own README, but you control the content globally by configuring the `readme` section in `generators.yml`.
8+
By default, Fern [generates the README automatically](./sdk-user-features) with usage examples and API details.
9+
10+
Although each SDK has its own README, the content can be configured globally through the `readme` section in the `generators.yml` file.
911

1012
## Configuration options
1113

1214
<Markdown src="/products/sdks/snippets/readme-options.mdx" />
1315

1416
## Additional customization
1517

16-
For customization beyond these configuration options, you can [manually modify the `README.md`](/products/sdks/custom-code.mdx) and add it to your `.fernignore` file to prevent it from being overwritten during regeneration.
18+
To go beyond the available configuration options, the `README.md` file can be [manually edited](/products/sdks/custom-code.mdx).
19+
Add it to the `.fernignore` file to prevent it from being overwritten during regeneration.

0 commit comments

Comments
 (0)