You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: Guide to configuring the README in your SDK
3
+
description: Guide to configuring the README.md in SDKs
4
4
---
5
5
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.
7
7
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.
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