Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a summary of package usage in client README #1905

Closed
trivikr opened this issue Jan 13, 2021 · 2 comments · Fixed by #1907
Closed

Add a summary of package usage in client README #1905

trivikr opened this issue Jan 13, 2021 · 2 comments · Fixed by #1907
Labels
feature-request New feature or enhancement. May require GitHub community feedback.

Comments

@trivikr
Copy link
Member

trivikr commented Jan 13, 2021

Is your feature request related to a problem? Please describe.
The client README doesn't contain client specific information. For example, the README from @aws-sdk/client-s3 just asks user to refer to generic root README.

Screenshot

Screen Shot 2021-01-12 at 7 07 08 PM

The README is used as a landing page at three places:

Describe the solution you'd like
Populate README providing detailed documentation like it was done for preview clients: https://www.npmjs.com/package/@aws-sdk/client-s3-node

Describe alternatives you've considered

Additional context
Refs: #1877 (comment)

@trivikr trivikr added the feature-request New feature or enhancement. May require GitHub community feedback. label Jan 13, 2021
@trivikr
Copy link
Member Author

trivikr commented Jan 13, 2021

README for preview clients was populated in

export function readme({ model, name: packageName, runtime }: ReadmeInterface) {

README for smithy clients is populated in

writerFactory.accept("README.md", writer -> {
String resource = IoUtils.readUtf8Resource(getClass(), "README.md.template");
resource = resource.replaceAll(Pattern.quote("${packageName}"), settings.getPackageName());
writer.write(resource);
});

@github-actions
Copy link

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs and link to relevant comments in this thread.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 29, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
feature-request New feature or enhancement. May require GitHub community feedback.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant