Skip to content

Commit 17598e8

Browse files
committed
fix: Fix Readme.md documentation and remove unecessary parts.
1 parent 9a436e3 commit 17598e8

File tree

2 files changed

+25
-6
lines changed

2 files changed

+25
-6
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,6 @@ assignees: ''
4141

4242
> [How to enable debug mode](https://awslabs.github.io/aws-lambda-powertools-java/#debug-mode)**
4343
44-
```python
44+
```java
4545
# paste logs here
4646
```

README.md

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,30 @@ A suite of utilities for AWS Lambda Functions that makes tracing with AWS X-Ray,
99

1010
### Installation
1111

12-
With [pip](https://pip.pypa.io/en/latest/index.html) installed, run: ``pip install aws-lambda-powertools``
13-
14-
## Example
15-
16-
See **[example](./example/README.md)** of all features, testing, and a SAM template with all Powertools env vars. All features also provide full docs, and code completion for VSCode and PyCharm.
12+
Powertools is available in Maven Central. You can use your favourite dependency management tool to install it
13+
14+
* [maven](https://maven.apache.org/):
15+
```xml
16+
<dependencies>
17+
...
18+
<dependency>
19+
<groupId>com.amazonaws</groupId>
20+
<artifactId>aws-lambda-powertools-java</artifactId>
21+
<version>YOUR_REQUIRED_VERSION</version>
22+
</dependency>
23+
...
24+
</dependencies>
25+
```
26+
* [gradle](https://gradle.org/):
27+
```
28+
repositories {
29+
mavenCentral()
30+
}
31+
32+
dependencies {
33+
powertools 'com.amazonaws:aws-lambda-powertools-java:YOUR_REQUIRED_VERSION'
34+
}
35+
```
1736

1837
## Credits
1938

0 commit comments

Comments
 (0)