add notes about custom header support

crystal-community · Jun 21, 2019 · cde3031 · cde3031
1 parent 4dd0e8b
commit cde3031
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,7 @@
 #### v1.1.0 2018-06-17
 
 * Adds RSA token support
+* Supports specifying custom headers
 * Supports skipping verification and validation
 * BREAKING: uses enum to select JWT Algorithm
 

diff --git a/README.md b/README.md
@@ -36,6 +36,9 @@ payload = { "foo" => "bar" }
 token = JWT.encode(payload, "SecretKey", JWT::Algorithm::HS256)
 # => "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJmb28iOiJiYXIifQ.Y3shN5Wh4FmOPM34biIm9QQmat373hJFKNxgSANQWJo"
 
+# Custom headers
+token = JWT.encode(payload, "SecretKey", JWT::Algorithm::HS256, custom: "header")
+
 # Decoding
 payload, header = JWT.decode(token, "$secretKey", JWT::Algorithm::HS256)
 # payload = {"foo" => "bar"}