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

feat(clients): update README with documentation, usage and more #1907

Merged
merged 18 commits into from
Jan 14, 2021

Conversation

trivikr
Copy link
Member

@trivikr trivikr commented Jan 13, 2021

Issue #, if available:
Fixes: #1878
Fixes: #1905

Description of changes:
Updates client README with the following:

  • Documentation of the client.
  • Installation.
  • Getting Started: Importing and Usage examples.
  • Troubleshooting.
  • Getting Help.
  • Contributing.
  • License.

Example README for DynamoDB Client

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@codecov-io
Copy link

codecov-io commented Jan 13, 2021

Codecov Report

Merging #1907 (1daf131) into master (f2a47e8) will increase coverage by 0.52%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1907      +/-   ##
==========================================
+ Coverage   79.30%   79.83%   +0.52%     
==========================================
  Files         368      368              
  Lines       15132    15549     +417     
  Branches     3222     3367     +145     
==========================================
+ Hits        12001    12413     +412     
- Misses       3131     3136       +5     
Impacted Files Coverage Δ
packages/util-waiter/src/utils/validate.ts 81.81% <0.00%> (-18.19%) ⬇️
lib/storage/src/data-chunk/readable-helper.ts 86.84% <0.00%> (-5.47%) ⬇️
packages/s3-request-presigner/src/getSignedUrl.ts 92.85% <0.00%> (-2.98%) ⬇️
packages/util-dynamodb/src/convertToAttr.ts 98.70% <0.00%> (-1.30%) ⬇️
packages/util-waiter/src/waiter.ts 100.00% <0.00%> (ø)
protocol_tests/aws-ec2/endpoints.ts 81.48% <0.00%> (ø)
protocol_tests/aws-json/endpoints.ts 81.48% <0.00%> (ø)
protocol_tests/aws-query/endpoints.ts 81.48% <0.00%> (ø)
packages/util-dynamodb/src/marshall.ts 100.00% <0.00%> (ø)
protocol_tests/aws-restxml/endpoints.ts 81.48% <0.00%> (ø)
... and 141 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1308721...1daf131. Read the comment docs.

@trivikr trivikr requested a review from AllanZhengYP January 13, 2021 18:07
@trivikr trivikr force-pushed the update-client-readme branch from ba85bd8 to 1daf131 Compare January 14, 2021 03:38
@trivikr trivikr changed the title feat: update client README with documentation, usage and more feat(clients): update README with documentation, usage and more Jan 14, 2021
@aws-sdk-js-automation
Copy link

AWS CodeBuild CI Report

  • CodeBuild project: sdk-staging-test
  • Commit ID: 1daf131
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@trivikr trivikr merged commit 03be111 into aws:master Jan 14, 2021
@trivikr trivikr deleted the update-client-readme branch January 14, 2021 03:55
@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
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a summary of package usage in client README Link to API Reference Client from README
4 participants