Skip to content

Commit 2bfaac9

Browse files
committed
updating readme
1 parent 0c5dfd7 commit 2bfaac9

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,14 @@
1-
# stackify-api-java
2-
31
[![Maven Central](https://img.shields.io/maven-central/v/com.stackify/stackify-api-java.svg)](http://mvnrepository.com/artifact/com.stackify/stackify-api-java)
4-
[![Build Status](https://travis-ci.org/stackify/stackify-api-java.png)](https://travis-ci.org/stackify/stackify-api-java)
52
[![Coverage Status](https://coveralls.io/repos/stackify/stackify-api-java/badge.png?branch=master)](https://coveralls.io/r/stackify/stackify-api-java?branch=master)
63

7-
Stackify API for Java
8-
9-
Errors and Logs Overview:
10-
11-
http://support.stackify.com/errors-and-logs-overview/
12-
13-
Sign Up for a Trial:
14-
15-
http://www.stackify.com/sign-up/
4+
## Stackify API for Java
165

17-
Log4j 1.2 Appender:
18-
19-
https://github.com/stackify/stackify-log-log4j12
20-
21-
Logback Appender:
22-
23-
https://github.com/stackify/stackify-log-logback
6+
* **Errors and Logs Overview:** http://support.stackify.com/errors-and-logs-overview/
7+
* **Sign Up for a Trial:** http://www.stackify.com/sign-up/
8+
* **Appenders**
9+
* **Log4j 1.2:** https://github.com/stackify/stackify-log-log4j12
10+
* **Log4j 2.x:** https://github.com/stackify/stackify-log-log4j2
11+
* **Logback:** https://github.com/stackify/stackify-log-logback
2412

2513
## Installation
2614

@@ -29,10 +17,12 @@ Add it as a maven dependency:
2917
<dependency>
3018
<groupId>com.stackify</groupId>
3119
<artifactId>stackify-api-java</artifactId>
32-
<version>INSERT_LATEST_MAVEN_CENTRAL_VERSION</version>
20+
<version>4.0.0</version>
3321
</dependency>
3422
```
3523

24+
25+
3626
## Configuration and Usage for Direct Logger
3727

3828
You need a stackify-api.properties file on your classpath that defines the configuration required for the Log API:
@@ -88,9 +78,9 @@ Be sure to shutdown the Direct Logger to flush this appender of any messages and
8878
LogManager.shutdown();
8979
```
9080

91-
### RUM Manual Instrumentation
81+
### RUM Setup
9282

93-
Real User Monitoring (RUM) manual instrumentation allows you to specify where the RUM JavaScript block is injected.
83+
Real User Monitoring (RUM) setup allows you to specify where the RUM JavaScript block is injected.
9484

9585
It is recommended you provide a `stackify-api.properties` file in your application classpath with the following content:
9686

@@ -115,11 +105,21 @@ Your application code will need to call out to the Stackify `com.stackify.apm.St
115105
</html>
116106
````
117107

108+
## Legacy Support
109+
110+
For legacy support of **Java 1.6 and 1.7** use the following maven dependency:
111+
```
112+
<dependency>
113+
<groupId>com.stackify</groupId>
114+
<artifactId>stackify-api-java</artifactId>
115+
<version>3.1.2</version>
116+
</dependency>
117+
```
118118

119119

120120
## License
121121

122-
Copyright 2013 Stackify, LLC.
122+
Copyright 2019 Stackify, LLC.
123123

124124
Licensed under the Apache License, Version 2.0 (the "License");
125125
you may not use this file except in compliance with the License.

0 commit comments

Comments
 (0)