Skip to content

docs: update README.md #1294

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 19, 2023
Merged

docs: update README.md #1294

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2c32d13
Update README.md
scottgerring Jul 19, 2023
2c6377a
Update README.md
scottgerring Jul 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 20 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,11 @@ Powertools for AWS Lambda (Java) is available in Maven Central. You can use your
</dependencies>
```

And configure the aspectj-maven-plugin to compile-time weave (CTW) the aws-lambda-powertools-java aspects into your project:
Next, configure the aspectj-maven-plugin to compile-time weave (CTW) the aws-lambda-powertools-java aspects into your project. A different configuration is needed for projects on Java 8.

For Java 11+, use the following:
<details>
<summary><b>Maven - Java 11 and newer</b></summary>

```xml
<build>
<plugins>
Expand Down Expand Up @@ -78,8 +80,11 @@ For Java 11+, use the following:
</plugins>
</build>
```
</details>

For Java 8, use the following:
<details>
<summary><b>Maven - Java 8</b></summary>

```xml
<build>
<plugins>
Expand Down Expand Up @@ -119,11 +124,12 @@ For Java 8, use the following:
</plugins>
</build>
```
#### gradle
</details>

For Java 11+:
<details>
<summary><b>Gradle - Java 11+</b></summary>

```groovy
```groovy
plugins {
id 'java'
id 'io.freefair.aspectj.post-compile-weaving' version '8.1.0'
Expand All @@ -141,11 +147,13 @@ For Java 11+:

sourceCompatibility = 11
targetCompatibility = 11
```
```
</details>

For Java8:
<details>
<summary><b>Gradle - Java 8</b></summary>

```groovy
```groovy
plugins {
id 'java'
id 'io.freefair.aspectj.post-compile-weaving' version '6.6.3'
Expand All @@ -163,10 +171,10 @@ For Java8:

sourceCompatibility = 1.8
targetCompatibility = 1.8
```

```
</details>

## Example
## Examples

See the **[examples](examples)** directory for example projects showcasing usage of different utilities.

Expand Down