mirror of https://github.com/golang-jwt/jwt.git
add installation guidelines to the README file (#204)
This commit is contained in:
parent
6e2ab4291f
commit
89a6400b7f
14
README.md
14
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.
|
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
|
## Examples
|
||||||
|
|
||||||
See [the project documentation](https://pkg.go.dev/github.com/golang-jwt/jwt/v4) for examples of usage:
|
See [the project documentation](https://pkg.go.dev/github.com/golang-jwt/jwt/v4) for examples of usage:
|
||||||
|
|
Loading…
Reference in New Issue