honeymoose/jjwt
1
0
Fork 0
mirror of https://github.com/jwtk/jjwt.git synced 2025-02-13 21:04:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source 
Added notes for projects that might have existing dependencies on an older Jackson version.
This commit is contained in:
Les Hazlewood 2014-09-26 13:32:19 -07:00
parent 563aead2bd
commit 57faa6e75a
1 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -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: Use your favorite Maven-compatible build tool to pull the dependency (and its transitive dependencies) from Maven Central:
```xml ```xml
<dependency> <dependency>
<groupId>io.jsonwebtoken</groupId> <groupId>io.jsonwebtoken</groupId>
<artifactId>jjwt</artifactId> <artifactId>jjwt</artifactId>
@ -19,6 +18,8 @@ Use your favorite Maven-compatible build tool to pull the dependency (and its tr
</dependency> </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 ## Usage
Most complexity is hidden behind convenient and readable Builder chaining calls. Here's an example: Most complexity is hidden behind convenient and readable Builder chaining calls. Here's an example:
@ -86,3 +87,16 @@ try {
* JWE (Encryption for JWT) * JWE (Encryption for JWT)
These feature sets will be implemented in a future release when possible. Community contributions are welcome! 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>
```