mirror of
https://github.com/jwtk/jjwt.git
synced 2025-02-13 15:14:46 +00:00
Update README.md
Added notes for projects that might have existing dependencies on an older Jackson version.
This commit is contained in:
parent
563aead2bd
commit
57faa6e75a
16
README.md
16
README.md
@ -11,7 +11,6 @@ JJWT is a 'clean room' implementation based solely on the [JWT](https://tools.ie
|
||||
Use your favorite Maven-compatible build tool to pull the dependency (and its transitive dependencies) from Maven Central:
|
||||
|
||||
```xml
|
||||
|
||||
<dependency>
|
||||
<groupId>io.jsonwebtoken</groupId>
|
||||
<artifactId>jjwt</artifactId>
|
||||
@ -19,6 +18,8 @@ Use your favorite Maven-compatible build tool to pull the dependency (and its tr
|
||||
</dependency>
|
||||
```
|
||||
|
||||
Note: JJWT depends on Jackson 2.x. If you're already using an older version of Jackson in your app, [read this](#olderJackson)
|
||||
|
||||
## Usage
|
||||
|
||||
Most complexity is hidden behind convenient and readable Builder chaining calls. Here's an example:
|
||||
@ -86,3 +87,16 @@ try {
|
||||
* JWE (Encryption for JWT)
|
||||
|
||||
These feature sets will be implemented in a future release when possible. Community contributions are welcome!
|
||||
|
||||
<a name="olderJackson"></a>
|
||||
#### Already using an older Jackson dependency?
|
||||
|
||||
JJWT depends on Jackson 2.4.x (or later). If you are already using a Jackson version in your own application less than 2.x, for example 1.9.x, you will likely see compile/build failures. To avoid this, you should upgrade your project's build configuration to point to a 2.x version of Jackson. For example:
|
||||
|
||||
```xml
|
||||
<dependency>
|
||||
<groupId>com.fasterxml.jackson.core</groupId>
|
||||
<artifactId>jackson-databind</artifactId>
|
||||
<version>2.4.2</version>
|
||||
</dependency>
|
||||
```
|
||||
|
Loading…
x
Reference in New Issue
Block a user