Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add installation guidelines to the README file #204

Merged
merged 3 commits into from May 27, 2022
Merged

add installation guidelines to the README file #204

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a8a1ec5
add installation guidelines
luigimorel May 19, 2022
6ae3e4f
change module link to v4
luigimorel May 26, 2022
b7ca421
Slight adjustments
oxisto May 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
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 [Go](https://go.dev/doc/install) installed, then you can use the below Go command to install jwt.

```sh
$ go get -u github.com/golang-jwt/jwt
oxisto marked this conversation as resolved.
Show resolved Hide resolved
```

2. Import it in your code:

```go
import "github.com/golang-jwt/jwt"
luigimorel marked this conversation as resolved.
Show resolved Hide resolved
```

## Examples

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