lobo/aws-sdk-for-zig
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects 1 Releases Wiki Activity

update readme
All checks were successful
continuous-integration/drone/push Build is passing
Details

Browse Source
This commit is contained in:
Emil Lerch 2022-01-10 18:40:15 -08:00
parent 1c41737202
commit 1e8ed763ce
Signed by: lobo
GPG Key ID: A7B62D657EF764F8
1 changed files with 7 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -9,9 +9,6 @@ tweaks in the signature calculation, which is planned for a zig version
(probably self-hosted 0.9.0) that no longer has an error triggered. Examples (probably self-hosted 0.9.0) that no longer has an error triggered. Examples
of usage are in src/main.zig. of usage are in src/main.zig.
This is my first serious zig effort, so please issue a PR if the code isn't
"ziggy" or if there's a better way.
This is designed to be built statically using the `aws_c_*` libraries, so This is designed to be built statically using the `aws_c_*` libraries, so
we inherit a lot of the goodness of the work going on there. Current we inherit a lot of the goodness of the work going on there. Current
executable size is 9.7M, about half of which is due to the SSL library. executable size is 9.7M, about half of which is due to the SSL library.
@ -19,7 +16,7 @@ Running strip on the executable after compilation (it seems zig strip
only goes so far), reduces this to 4.3M. This is for x86_linux, only goes so far), reduces this to 4.3M. This is for x86_linux,
(which is all that's tested at the moment). (which is all that's tested at the moment).
# 2021-10-28 SDK Update # 2022-01-10 SDK Update
To get smaller executable size and better portability with faster compilation, To get smaller executable size and better portability with faster compilation,
my intent is to rework the http communications using my intent is to rework the http communications using
@ -30,13 +27,12 @@ along with support for some S3 quirks, etc. It will also reduce compatibility
with some edge cases. Long term I think this is a better approach, however and with some edge cases. Long term I think this is a better approach, however and
will remove (or replace) a ton of the C dependencies as well as avoid a bunch will remove (or replace) a ton of the C dependencies as well as avoid a bunch
of complexity such as the event loop C implementation found in the AWS of complexity such as the event loop C implementation found in the AWS
libraries, which eventually could be replaced by zig async. I will create a new branch libraries, which eventually could be replaced by zig async. I have created a
for this work as master is currently working fairly well. My hope is to [new branch](https://github.com/elerch/aws-sdk-for-zig/tree/zig-native)
converge on Zig 0.9.0 so this SDK doesn't have to keep up with changes going on for this work as master is currently working fairly well. I'd also love to have
in zig master. I'd also love to have an official package manager in zig, but I an official package manager in zig, but I know this is high on the priority
know this is high on the priority list for the foundation. My goal is to **not** require list for the foundation. In the meantime I will depend on git commands executed
[gyro](https://github.com/mattnite/gyro) as requestz does, but we'll see how by build.zig to handle packages.
that develops.
## Building ## Building
@ -114,8 +110,6 @@ TODO List:
* Implement timeouts and other TODO's in the code * Implement timeouts and other TODO's in the code
* Switch to aws-c-cal upstream once [PR for full static musl build support is merged](https://github.com/awslabs/aws-c-cal/pull/89) * Switch to aws-c-cal upstream once [PR for full static musl build support is merged](https://github.com/awslabs/aws-c-cal/pull/89)
(see Dockerfile) (see Dockerfile)
* Move to compiler on tagged release (hopefully 0.8.1)
(new 2021-05-29. I will proceed in this order unless I get other requests)
* Implement [AWS restXml protocol](https://awslabs.github.io/smithy/1.0/spec/aws/aws-restxml-protocol.html). * Implement [AWS restXml protocol](https://awslabs.github.io/smithy/1.0/spec/aws/aws-restxml-protocol.html).
Includes S3. Total service count 4. This may be blocked due to the same issue as EC2. Includes S3. Total service count 4. This may be blocked due to the same issue as EC2.
* Implement [AWS EC2 query protocol](https://awslabs.github.io/smithy/1.0/spec/aws/aws-ec2-query-protocol.html). * Implement [AWS EC2 query protocol](https://awslabs.github.io/smithy/1.0/spec/aws/aws-ec2-query-protocol.html).