Skip to content

Commit

Permalink
add installation guidelines to the README file (#204)
Browse files Browse the repository at this point in the history
  • Loading branch information
luigimorel committed May 27, 2022
1 parent 6e2ab42 commit 89a6400
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Expand Up @@ -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:
Expand Down

0 comments on commit 89a6400

Please sign in to comment.