Skip to content

Commit 7c37c5e

Browse files
committed
docs: initial release documentation
1 parent 640900e commit 7c37c5e

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

README.md

+17-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ OWASP Java Encoder Project
44
[![Build Status](https://travis-ci.org/OWASP/owasp-java-encoder.svg?branch=main)](https://travis-ci.org/OWASP/owasp-java-encoder) [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause) [![javadoc](https://javadoc.io/badge2/org.owasp.encoder/encoder/javadoc.svg)](https://javadoc.io/doc/org.owasp.encoder/encoder)
55

66
Contextual Output Encoding is a computer programming technique necessary to stop
7-
Cross-Site Scripting. This project is a Java 1.5+ simple-to-use drop-in high-performance
7+
Cross-Site Scripting. This project is a Java 1.8+ simple-to-use drop-in high-performance
88
encoder class with little baggage.
99

1010
For more detailed documentation on the OWASP Javca Encoder please visit https://owasp.org/www-project-java-encoder/.
@@ -21,13 +21,23 @@ The jars are also available in Maven:
2121
<dependency>
2222
<groupId>org.owasp.encoder</groupId>
2323
<artifactId>encoder</artifactId>
24-
<version>1.2.3</version>
24+
<version>1.3.0</version>
2525
</dependency>
2626

2727
<dependency>
2828
<groupId>org.owasp.encoder</groupId>
2929
<artifactId>encoder-jsp</artifactId>
30-
<version>1.2.3</version>
30+
<version>1.3.0</version>
31+
</dependency>
32+
```
33+
34+
If using Java 17 and need to use the Jakarta Servelt Spec you can use:
35+
36+
```xml
37+
<dependency>
38+
<groupId>org.owasp.encoder</groupId>
39+
<artifactId>encoder-jakarta-jsp</artifactId>
40+
<version>1.3.0</version>
3141
</dependency>
3242
```
3343

@@ -50,6 +60,10 @@ Happy Encoding!
5060

5161
News
5262
----
63+
### 2024-08-01 - 1.2.3 Release
64+
The team is happy to announce that version 1.3.0 has been released!
65+
66+
5367
### 2020-11-08 - 1.2.3 Release
5468
The team is happy to announce that version 1.2.3 has been released!
5569
* Update to make the manifest OSGi-compliant (#39).

0 commit comments

Comments
 (0)