From 89a6400b7fe5e5b9e7872ceb14ee9b5a6e2255b7 Mon Sep 17 00:00:00 2001 From: Luigi Morel <48476293+morelmiles@users.noreply.github.com> Date: Sat, 28 May 2022 02:07:25 +0300 Subject: [PATCH] add installation guidelines to the README file (#204) --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 423cfd72..f5d551ca 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,20 @@ The part in the middle is the interesting bit. It's called the Claims and conta This library supports the parsing and verification as well as the generation and signing of JWTs. Current supported signing algorithms are HMAC SHA, RSA, RSA-PSS, and ECDSA, though hooks are present for adding your own. +## Installation Guidelines + +1. To install the jwt package, you first need to have [Go](https://go.dev/doc/install) installed, then you can use the command below to add `jwt-go` as a dependency in your Go program. + +```sh +go get -u github.com/golang-jwt/jwt/v4 +``` + +2. Import it in your code: + +```go +import "github.com/golang-jwt/jwt/v4" +``` + ## Examples See [the project documentation](https://pkg.go.dev/github.com/golang-jwt/jwt/v4) for examples of usage: