Skip to content

Commit c0b46af

Browse files
committed
chore: update README
1 parent 820b6a1 commit c0b46af

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
[![CI](https://github.com/f34nk/smithy-unison/actions/workflows/ci.yml/badge.svg)](https://github.com/f34nk/smithy-unison/actions/workflows/ci.yml)
66

7-
Generates Unison client code from Smithy service models. Produces client modules, type definitions, and HTTP request/response handling for service operations.
7+
Generates [Unison](https://www.unison-lang.org/) client code from Smithy service models. Produces client modules, type definitions, and HTTP request/response handling for service operations.
88

99
Reference: https://smithy.io/2.0/index.html
1010

@@ -72,13 +72,21 @@ Run all example builds:
7272
make examples
7373
```
7474

75-
Or generate and run the official [AWS SDK S3 model](https://github.com/aws/api-models-aws/tree/main/models/s3/service/2006-03-01):
75+
Run demo:
7676

7777
```bash
7878
make demo
7979
```
8080

81-
The [demo application](https://github.com/f34nk/smithy-unison/blob/main/examples/aws-demo/src/main.u) executes functions from the generated `s3_client` against a mocked S3 bucket.
81+
The [demo application](https://github.com/f34nk/smithy-unison/blob/main/examples/aws-demo/src/main.u) generates the `aws_s3_client` from the official [AWS SDK S3 model](https://github.com/aws/api-models-aws/tree/main/models/s3/service/2006-03-01), compiles it locally and executes functions against a mocked S3 bucket in Docker Compose.
82+
83+
Run integration-test:
84+
85+
```bash
86+
make integration-test
87+
```
88+
89+
The **integration-test** installs and compiles the [Unison AWS library](https://github.com/f34nk/smithy-unison/blob/main/examples/aws-demo/compile-with-lib.sh#L11) (generated with `smithy-unison` and released to [Unison Share @f34nk/aws](https://share.unison-lang.org/@f34nk/aws)) and runs the [demo application](https://github.com/f34nk/smithy-unison/blob/main/examples/aws-demo/src/main.u) against a mocked S3 bucket in Docker Compose.
8290

8391
## Basic Usage
8492

@@ -238,6 +246,12 @@ getObject config input =
238246
-- Raises exception on error, returns output directly on success
239247
```
240248

249+
## AWS SDK Generator (experimental)
250+
251+
Use the AWS SDK Generator to generate unison code for any available AWS SDK.
252+
253+
Check out [generate-aws-sdk](https://github.com/f34nk/smithy-unison/blob/main/generate-aws-sdk/README.md) for details.
254+
241255
## License
242256

243257
Apache License 2.0

0 commit comments

Comments
 (0)