Skip to content

Commit 3558b63

Browse files
luigimoreloxisto
authored andcommitted
add installation guidelines to the README file (golang-jwt#204)
1 parent 0c8bc44 commit 3558b63

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,20 @@ The part in the middle is the interesting bit. It's called the Claims and conta
3636

3737
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.
3838

39+
## Installation Guidelines
40+
41+
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.
42+
43+
```sh
44+
go get -u github.com/golang-jwt/jwt/v4
45+
```
46+
47+
2. Import it in your code:
48+
49+
```go
50+
import "github.com/golang-jwt/jwt/v4"
51+
```
52+
3953
## Examples
4054

4155
See [the project documentation](https://pkg.go.dev/github.com/golang-jwt/jwt/v4) for examples of usage:

0 commit comments

Comments
 (0)