Skip to content

Commit

Permalink
docs: update READMEs
Browse files Browse the repository at this point in the history
Updates READMEs of `xray-lite` and `xray-lite-aws-sdk` supposing the
crates are published to crates.io.
  • Loading branch information
kikuomax committed Mar 30, 2024
1 parent 66c8521 commit 2f43e39
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 8 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ Add the following to your `Cargo.toml` file:

```toml
[dependencies]
xray-lite = { git = "https://github.com/codemonger-io/xray-lite.git", tag = "v0.0.8" }
xray-lite = "0.0.9"
```

## Usage

### Subsegment of AWS service operation

**The [`xray-lite-aws-sdk`](./xray-lite-aws-sdk) extension is recommended for tracing requests through [AWS SDK for Rust](https://aws.amazon.com/sdk-for-rust/).**
**The [`xray-lite-aws-sdk`](./xray-lite-aws-sdk) extension is recommended for tracing operations through [AWS SDK for Rust](https://aws.amazon.com/sdk-for-rust/).**

Here is an example to record a subsegment of an AWS service operation within a Lambda function invocation instrumented with AWS X-Ray:

Expand Down Expand Up @@ -145,8 +145,8 @@ fn do_s3_get_object(context: &impl Context) {

## API Documentation

- [`xray-lite`](https://codemonger-io.github.io/xray-lite/api/xray_lite/)
- [`xray-lite-aws-sdk`](https://codemonger-io.github.io/xray-lite/api/xray_lite_aws_sdk/)
- [`xray-lite`](https://docs.rs/xray-lite)
- [`xray-lite-aws-sdk`](https://docs.rs/xray-lite-aws-sdk)

## Acknowledgements

Expand Down
5 changes: 1 addition & 4 deletions xray-lite-aws-sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,9 @@ Add the following to your `Cargo.toml` file:

```toml
[dependencies]
xray-lite = { git = "https://github.com/codemonger-io/xray-lite.git", tag = "aws-sdk-v0.0.3" }
xray-lite-aws-sdk = { git = "https://github.com/codemonger-io/xray-lite.git", tag = "aws-sdk-v0.0.3" }
xray-lite-aws-sdk = "0.0.4"
```

**You have to install `xray-lite` and `xray-lite-aws-sdk` from the same commit!**

## Usage

With this crate, you can easily add the X-Ray tracing capability to your AWS service requests through [AWS SDK for Rust](https://aws.amazon.com/sdk-for-rust/).
Expand Down

0 comments on commit 2f43e39

Please sign in to comment.