Skip to content

Commit 9804ffa

Browse files
committed
Add README
1 parent 7fde95f commit 9804ffa

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

README.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Firebase JWT
2+
3+
This Go package provides a convienent method to parse auth JWT issued by [Firebase Authentication](https://firebase.google.com/docs/auth).
4+
5+
## Auth token
6+
7+
An authentication token (auth token) is a computer generated code that helps to verify if user's identity is authentic or not.
8+
JWT or Json Web Token is one type of auth token which is used as Bearer token and self-signed. Read more at [JWT.io](https://jwt.io/)
9+
10+
## Usage
11+
12+
### Installation guide
13+
14+
```bash
15+
go get github.com/ubbn/[email protected]
16+
```
17+
18+
### Import it
19+
20+
```go
21+
import github.com/ubbn/firebasejwt
22+
23+
func main() {
24+
claims, err := firebasejwt.ParseFirebaseJWT("<token issued by firebase auth>")
25+
fmt.Println(claims["name"])
26+
fmt.Println(claims["email"])
27+
}
28+
```
29+
30+
### More
31+
32+
Package documentation can be found on [pkg.go.dev](https://pkg.go.dev/github.com/ubbn/firebasejwt)

0 commit comments

Comments
 (0)