readme.go

// This file was auto-generated by Fern from our API Definition.

package generatorexec

// The standard sections included in every generated README.md
//
// # {{title}}
//
// {{badge}} [Fern Badge]
//
// {{summary}}
//
// ## API Documentation
//
// API Reference Documentation is available {{here}}.
//
// ## Installation
//
// {{installation}}
//
// ## Usage
//
// {{usage}}
//
// ## Async Client
//
// {{asyncUsage}}
//
// ## Environments
//
// {{environments}}
//
// ## Custom URL
//
// {{customUrl}}
//
// ## Handling Errors
//
// {{errors}}
//
// ## Advanced: Setting Timeouts
//
// {{timeouts}}
//
// ## Advanced: Request Options
//
// {{requestOptions}}}
//
// ## Beta Status
//
// Some info about beta status.
//
// ## Contributing
//
// Some info about contributing.
type GenerateReadmeRequest struct {
	// The title (e.g. Acme Python Library ...)
	Title string `json:"title"`
	// Badges rendered alongside the standard Fern badge
	Badge *BadgeType `json:"badge,omitempty"`
	// The summary included below the badges (e.g. The Acme Python library provides ...)
	Summary string `json:"summary"`
	// Each requirement is rendered as a bulleted list
	Requirements []string `json:"requirements,omitempty"`
	// The installation steps
	Installation *string `json:"installation,omitempty"`
	// Section describing how to instantiate the client (i.e. a code snippet)
	Usage string `json:"usage"`
	// Section describing how to instantiate an async client
	AsyncUsage *string `json:"asyncUsage,omitempty"`
	// Section describing how to set timeouts
	Timeouts *string `json:"timeouts,omitempty"`
	// If multiple environments, a section for how to specify multiple environments
	Environments *string `json:"environments,omitempty"`
	// Section describing how to set a custom url
	CustomUrl *string `json:"customUrl,omitempty"`
	// Section describing how to set request options
	RequestOptions *string `json:"requestOptions,omitempty"`
}