From b86c4fd7c363278d6752561a3b9bc88eda6473f3 Mon Sep 17 00:00:00 2001 From: Tim Rudat Date: Thu, 5 Oct 2017 17:34:21 +0200 Subject: [PATCH] Update README.md Remove the default mark from the HS256 algorithm as mentioned in #226. Add a note on using the ED25519 algorithm depending on RbNaCl. --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2fb99582..7c81cfd8 100644 --- a/README.md +++ b/README.md @@ -61,9 +61,9 @@ decoded_token = JWT.decode token, nil, false puts decoded_token ``` -**HMAC** (default: HS256) +**HMAC** -* HS256 - HMAC using SHA-256 hash algorithm (default) +* HS256 - HMAC using SHA-256 hash algorithm * HS512256 - HMAC using SHA-512-256 hash algorithm (only available with RbNaCl; see note below) * HS384 - HMAC using SHA-384 hash algorithm * HS512 - HMAC using SHA-512 hash algorithm @@ -146,6 +146,14 @@ puts decoded_token **EDDSA** +In order to use this algorithm you need to add the `RbNaCl` gem to you `Gemfile`. + +```ruby +gem 'rbnacl' +``` + +For more detailed installation instruction check the official [repository](https://github.com/cryptosphere/rbnacl) on GitHub. + * ED25519 ```ruby