src

Go monorepo.
git clone git://code.dwrz.net/src
Log | Files | Refs

README.md (1447B)

      1 ## Smithy Go
      2 
      3 [![Go Build Status](https://github.com/aws/smithy-go/actions/workflows/go.yml/badge.svg?branch=main)](https://github.com/aws/smithy-go/actions/workflows/go.yml)[![Codegen Build Status](https://github.com/aws/smithy-go/actions/workflows/codegen.yml/badge.svg?branch=main)](https://github.com/aws/smithy-go/actions/workflows/codegen.yml)
      4 
      5 [Smithy](https://smithy.io/) code generators for Go.
      6 
      7 **WARNING: All interfaces are subject to change.**
      8 
      9 ## Can I use this?
     10 
     11 In order to generate a usable smithy client you must provide a [protocol definition](https://github.com/aws/smithy-go/blob/main/codegen/smithy-go-codegen/src/main/java/software/amazon/smithy/go/codegen/integration/ProtocolGenerator.java),
     12 such as [AWS restJson1](https://smithy.io/2.0/aws/protocols/aws-restjson1-protocol.html),
     13 in order to generate transport mechanisms and serialization/deserialization
     14 code ("serde") accordingly.
     15 
     16 The code generator does not currently support any protocols out of the box,
     17 therefore the useability of this project on its own is currently limited.
     18 Support for all [AWS protocols](https://smithy.io/2.0/aws/protocols/index.html)
     19 exists in [aws-sdk-go-v2](https://github.com/aws/aws-sdk-go-v2). We are
     20 tracking the movement of those out of the SDK into smithy-go in
     21 [#458](https://github.com/aws/smithy-go/issues/458), but there's currently no
     22 timeline for doing so.
     23 
     24 ## License
     25 
     26 This project is licensed under the Apache-2.0 License.
     27