Skip to content

Fix README to reference v2 Go SDK #116

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Nov 20, 2024
Merged

Fix README to reference v2 Go SDK #116

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ Code generator for Elixir and Erlang AWS client.

## Generating code

The code generator uses specs from the [AWS SDK for the Go programming
language][aws-sdk-go] to generate code.
The code generator uses specs from the [AWS SDK v2 for the Go programming
language][aws-sdk-go-v2] to generate code.

Code is generated by running the `generate.exs` script. It requires Elixir 1.8.4+.

### Elixir

```bash
export SPEC_PATH=../../aws/aws-sdk-go/models/apis
export SPEC_PATH=../../aws/aws-sdk-go-v2/codegen/sdk-codegen/aws-models
export TEMPLATE_PATH=priv
export ELIXIR_OUTPUT_PATH=../aws-elixir/lib/aws/generated
mix run generate.exs elixir $SPEC_PATH $TEMPLATE_PATH $ELIXIR_OUTPUT_PATH
Expand All @@ -21,7 +21,7 @@ mix run generate.exs elixir $SPEC_PATH $TEMPLATE_PATH $ELIXIR_OUTPUT_PATH
### Erlang

```bash
export SPEC_PATH=../../aws/aws-sdk-go/models/apis
export SPEC_PATH=../../aws/aws-sdk-go-v2/codegen/sdk-codegen/aws-models
export TEMPLATE_PATH=priv
export ERLANG_OUTPUT_PATH=../aws-erlang/src
mix run generate.exs erlang $SPEC_PATH $TEMPLATE_PATH $ERLANG_OUTPUT_PATH
Expand All @@ -30,7 +30,7 @@ mix run generate.exs erlang $SPEC_PATH $TEMPLATE_PATH $ERLANG_OUTPUT_PATH
## AWS Protocols

Each AWS API uses a specific protocol which is defined in its
specification JSON file in the [aws-sdk-go][] repository. The existing
specification JSON file in the [aws-sdk-go-v2][] repository. The existing
protocols are:

- json
Expand Down Expand Up @@ -75,5 +75,5 @@ Alternatively you can install XCode's Command Line Developer Tools package:

$ xcode-select --install

[aws-sdk-go]: https://github.com/aws/aws-sdk-go
[aws-sdk-go-v2]: https://github.com/aws/aws-sdk-go-v2
[brew]: https://brew.sh/
Loading