diff --git a/internal/oauth/README.md b/internal/oauth/README.md index 50a9e1274..f739aa60d 100644 --- a/internal/oauth/README.md +++ b/internal/oauth/README.md @@ -1,3 +1,5 @@ # oauth This package provides uses the [GoToSocial oauth2](https://github.com/gotosocial/oauth2) module (forked from [go-oauth2](https://github.com/go-oauth2/oauth2)) to provide [oauth2](https://www.oauth.com/) server functionality to the GoToSocial APIs. + +It also provides a handler/middleware for attaching to the Gin engine for validating authenticated users.