summaryrefslogtreecommitdiff
path: root/internal/module/oauth/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'internal/module/oauth/README.md')
-rw-r--r--internal/module/oauth/README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/internal/module/oauth/README.md b/internal/module/oauth/README.md
new file mode 100644
index 000000000..3d8427302
--- /dev/null
+++ b/internal/module/oauth/README.md
@@ -0,0 +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/) functionality to the GoToSocial client API.
+
+It also provides a handler/middleware for attaching to the Gin engine for validating authenticated users.