---
title: README.md configuration | Stainless
description: Configure code examples in your generated SDK Readme file. Set headline, pagination, and default example requests to showcase your API's most important endpoints.
---

[\[reference\]](/docs/reference/config#readme/index.md)

We currently support configuration of the various code snippets in the `README.md` of a generated SDK.

```
readme:
  example_requests:
    default:
      type: request
      endpoint: post /cards
      params:
        type: SINGLE_USE
    headline:
      type: request
      endpoint: put /cards
      params:
        type: SINGLE_USE
        account_id: 123
    pagination:
      type: request
      endpoint: get /cards
      params:
        limit: 30
```

The `headline` example is the first usage of the API that your users see in the `README.md`, so it should be the most ‘important’ endpoint in your API.

The `pagination` example is required if you have configured pagination, and should point to a paginated endpoint.

The `default` example is inherited by all other example requests, though you can manually override them if there is a need to do so. Because of this, we suggest that you choose the most ‘standard’ endpoint in your API.