Skip to content

Commit 8bdf7a8

Browse files
pspeterarminru
authored andcommitted
Fix typos and improve wording in readme (#20)
1 parent f818d23 commit 8bdf7a8

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ This is the official Java implementation of the [Dynatrace OneAgent SDK](https:/
3030

3131
## Package contents
3232

33-
* `samples`: contains sample application, which demonstrates the usage of the SDK. see readme inside the samples directory for more details
33+
* `samples`: contains sample application, which demonstrates the usage of the SDK. See readme inside the samples directory for more details.
3434
* `docs`: contains the reference documentation (javadoc). The most recent version is also available online at [https://dynatrace.github.io/OneAgent-SDK-for-Java/](https://dynatrace.github.io/OneAgent-SDK-for-Java/).
35-
* `LICENSE`: license under which the whole SDK and sample applications are published
35+
* `LICENSE`: license under which the whole SDK and sample applications are published.
3636

3737
## Requirements
3838

@@ -53,7 +53,7 @@ This is the official Java implementation of the [Dynatrace OneAgent SDK](https:/
5353

5454
### Dependencies
5555

56-
If you want to integrate the OneAgent SDK into your application, just add the following maven dependency:
56+
If you want to integrate the OneAgent SDK into your application, just add the following Maven dependency:
5757

5858
```xml
5959
<dependency>
@@ -64,7 +64,7 @@ If you want to integrate the OneAgent SDK into your application, just add the fo
6464
</dependency>
6565
```
6666

67-
If you prefer to integrate the SDK using plain jar file, just download them from mavenCentral. You can find the download links for each
67+
If you prefer to integrate the SDK using plain jar file, just download them from Maven Central. You can find the download links for each
6868
version in the [Release notes](#releasenotes) section.
6969

7070
The Dynatrace OneAgent SDK for Java has no further dependencies.
@@ -83,12 +83,12 @@ Additionally you should/have to ensure, that you have set a `LoggingCallback`. F
8383

8484
## API concepts
8585

86-
Common concepts of the Dynatrace OneAgent SDK are explained the [Dynatrace OneAgent SDK repository](https://github.com/Dynatrace/OneAgent-SDK#apiconcepts).
86+
Common concepts of the Dynatrace OneAgent SDK are explained in the [Dynatrace OneAgent SDK repository](https://github.com/Dynatrace/OneAgent-SDK#apiconcepts).
8787

8888
### OneAgentSDK object
8989

90-
Use OneAgentSDKFactory.createInstance() to obtain an OneAgentSDK instance. You should reuse this object over the whole application
91-
and if possible JVM lifetime:
90+
Use OneAgentSDKFactory.createInstance() to obtain an OneAgentSDK instance. You should reuse this object throughout the whole application
91+
and, if possible, JVM lifetime:
9292

9393
```Java
9494
OneAgentSDK oneAgentSdk = OneAgentSDKFactory.createInstance();
@@ -104,13 +104,13 @@ default:
104104
}
105105
```
106106

107-
It is good practice to check the SDK state regularly as it may change at every point of time (except PERMANENTLY_INACTIVE never
108-
changes over JVM lifetime).
107+
It is good practice to check the SDK state regularly as it may change at any point in time (except for PERMANENTLY_INACTIVE, which never
108+
changes throughout the JVM lifetime).
109109

110110
### Tracers
111111

112112
To trace any kind of call you first need to create a Tracer. The Tracer object represents the logical and physical endpoint that
113-
you want to call. A Tracer serves two purposes. First to time the call (duration, cpu and more) and report errors. That is why
113+
you want to call. A Tracer serves two purposes. First, to time the call (duration, cpu and more) and report errors. That is why
114114
each Tracer has these three methods. The error method must be called only once, and it must be in between start and end.
115115

116116
```Java

0 commit comments

Comments
 (0)