import { unixEOL } from '@sap-cloud-sdk/util' ; import { helpfulLinksSection } from '@sap-cloud-sdk/generator-common/internal' ; import { OpenApiDocument } from '../openapi-types' ; import { getApiSpecificUsage } from '../sdk-metadata' ; param openApiDocument returns internal export function readme ( openApiDocument ) { return `# ${ openApiDocument . serviceOptions . packageName }

This package contains the OpenAPI client for the ${ openApiDocument . serviceName }.
${ openApiDocument . serviceDescription ?? '' }

${ addUsageExample ( openApiDocument ) . join ( unixEOL ) }
${ helpfulLinksSection ( ) . join ( unixEOL ) }
    
` ; } function addUsageExample ( openApiDocument ) { const usageText = getApiSpecificUsage ( openApiDocument ) ; if ( usageText . instructions ) { return [ `## ${ usageText . header }` , '```' , `${ usageText . instructions }` , '```' , '' ] ; } return [ ] ; }