From 67e2013f7999ab43ba991d27146afb0382b7b792 Mon Sep 17 00:00:00 2001 From: Fergus Ruston Date: Thu, 18 May 2023 15:29:21 +0100 Subject: [PATCH] docs: clarify what the package does and its differences to fastify-jwt (#7) --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3cbdec9..f87b9c5 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,11 @@ [![Package Version](https://img.shields.io/npm/v/fastify-jwt-jwks.svg)](https://npm.im/fastify-jwt-jwks) [![ci](https://github.com/nearform/fastify-jwt-jwks/actions/workflows/ci.yml/badge.svg)](https://github.com/nearform/fastify-jwt-jwks/actions/workflows/ci.yml) -JWT verification plugin for Fastify, internally uses [@fastify/jwt](https://www.npmjs.com/package/@fastify/jwt). +JSON Web Key Set (JWKS) verification plugin for Fastify, internally uses [@fastify/jwt](https://www.npmjs.com/package/@fastify/jwt). + +#### Note + +JSON Web Key Sets (JWKS) are used to verify that a signed JWT originated from a particular authorization server, and that the token hasn't been tampered with. If you are looking to implement JWT authentication in your Fastify application you may be looking for [@fastify/jwt](https://www.npmjs.com/package/@fastify/jwt). ## Installation