From 5f013e687a9526dd4bf0e034bff288bcf0b4bc6a Mon Sep 17 00:00:00 2001 From: timonson Date: Thu, 10 Dec 2020 13:45:42 +0100 Subject: [PATCH] Improve documentation --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 49b9c6b..a024a15 100644 --- a/README.md +++ b/README.md @@ -28,8 +28,9 @@ const payload = await verify(jwt, "secret", "HS512") // { foo: "bar" } ### decode -Takes a `jwt` to return an object with the `header`, `payload` and `signature` -properties if the `jwt` is valid. Otherwise it throws an `Error`. +Takes a `jwt` and returns an object with the `header`, `payload` and `signature` +properties if the `jwt` is valid (without signature verification). Otherwise it +throws an `Error`. ```typescript import { decode } from "https://deno.land/x/djwt@$VERSION/mod.ts" @@ -92,3 +93,11 @@ This application uses the JWS Compact Serialization only. - [JSON Web Token](https://tools.ietf.org/html/rfc7519) - [JSON Web Signature](https://www.rfc-editor.org/rfc/rfc7515.html) - [JSON Web Algorithms](https://www.rfc-editor.org/rfc/rfc7518.html) + +## Contribution + +Every kind of contribution to this project is highly appreciated. Please run +`deno fmt` on the changed files before making a pull request. + +Big **Thank you** to [timreichen](https://github.com/timreichen) and all the +other amazing contributors.