Update README for Developer Preview - #85
Conversation
db9ce0b to
7a648e6
Compare
alexgromero
left a comment
alexgromero
left a comment
There was a problem hiding this comment.
Overall this looks good! I think we could tweak the flow a bit to get users to the Quick start sooner. It might read more naturally as intro --> installation --> Quick start --> additional setup/details like bidirectional streaming.
| individual client packages when your application uses only one or two services | ||
| and you want the smallest dependency set. | ||
|
|
||
| ### Bidirectional streaming transport |
There was a problem hiding this comment.
I would move this after Quick start so Installation flows directly into the basic example.
| each AWS service client. Install the client packages that the following | ||
| examples use: |
There was a problem hiding this comment.
I like showing the different ways to install clients here, but I wonder if we need to frame it around the examples below. Could this section just explain client installation generally, then Quick start installs aws-sdk-sts for its example? We could also use different clients here for a little more variety, instead of installing the same Bedrock client again below with the awscrt extra.
| ``` | ||
| python -m pip install aws-sdk-sts aws-sdk-bedrock-runtime | ||
| ``` |
There was a problem hiding this comment.
small nit: could we use bash for the install commands? GitHub gives them a bit of syntax highlighting.
| return AsyncBedrockRuntimeClient(config=config) | ||
| ``` | ||
|
|
||
| ## Quick start |
There was a problem hiding this comment.
Could we make this a little more step-by-step? Like install aws-sdk-sts, make sure region/credentials are configured, then run the example. Similar to Using Boto3.
2 participants
Description of changes:
Updates the root README for the Developer Preview:
Note: content reflects the final dev preview release state. Changes such as smithy-lang/smithy-python#765 has not been released yet. The developer guide has not been published yet as well. We should merge this PR only after all those changes land. At that time we'll update the "About" section of the repo as well.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.