Skip to content

Commit 84ca5fa

Browse files
committed
add readme example
1 parent 85d588d commit 84ca5fa

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,4 @@ Although each SDK has its own README, the content can be configured globally thr
1515

1616
## Additional customization
1717

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.
18+
To go beyond the available configuration options, you can [manually edit the `README.md` file](/products/sdks/custom-code.mdx). Then, add it to the `.fernignore` file to prevent it from being overwritten during regeneration.

fern/products/sdks/guides/generated-sdk.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ description: How your customers can use your SDK
55

66
Fern-generated SDKs provide a consistent set of features across all languages to help developers interact with your API. Usage information is auto-generated in your SDK's `README.md`, [which you can customize](./readme).
77

8+
For a complete example of a generated SDK README, see [Intercom's Python SDK](https://github.com/intercom/python-intercom/blob/3aac991a92cefe34cf437f8f5ca46c97c04c1a6c/README.md).
9+
810
## Installation and basic usage
911

1012
Users install SDKs using standard package managers (npm for TypeScript, pip for Python, Maven/Gradle for Java, etc.) from language-specific registries.

0 commit comments

Comments
 (0)