From c364efd8e8efd17f7d640bc348985deb8385e661 Mon Sep 17 00:00:00 2001 From: Emil Lerch Date: Fri, 4 Aug 2023 09:38:25 -0700 Subject: [PATCH] update readme to reflect the pending 0.11 move --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4e26551..dc3ab25 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,10 @@ -# AWS SDK for Zig +AWS SDK for Zig +=============== [![Build Status](https://actions-status.lerch.org/lobo/aws-sdk-for-zig/build)](https://git.lerch.org/lobo/aws-sdk-for-zig/actions?workflow=build.yaml&state=closed) +**Now that 0.11 has been released, work will commence to move to the new compiler** + Current executable size for the demo is 1.7M (90k of which is the AWS PEM file, and approximately 600K for XML services) after compiling with -Drelease-safe and [stripping the executable after compilation](https://github.com/ziglang/zig/issues/351). @@ -17,7 +20,8 @@ This is for x86_linux, and will vary based on services used. Tested targets: Tested targets are built, but not continuously tested, by CI. -## Building +Building +-------- `zig build` should work. It will build the code generation project, run the code generation, then build the main project with the generated code. @@ -25,7 +29,8 @@ the code generation, then build the main project with the generated code. First time build should use `zig build -Dfetch` to fetch dependent packages (zfetch and friends). -## Running +Running +------- This library mimics the aws c libraries for it's work, so it operates like most other 'AWS things'. main.zig gives you a handful of examples for working with services. @@ -38,14 +43,14 @@ require passing in a client option to specify an different TLS root certificate The [old branch](https://github.com/elerch/aws-sdk-for-zig/tree/aws-crt) exists for posterity, and supports x86_64 linux. The old branch is deprecated. -## Limitations +Limitations +----------- WebIdentityToken is not yet implemented. TODO List: * Bump to zig 0.11 and replace zFetch with [std.http.Client](https://github.com/ziglang/zig/blob/master/lib/std/http/Client.zig) -* Verify strip on static builds in 0.11 * Implement sigv4a signing * Implement jitter/exponential backoff * Implement timeouts and other TODO's in the code