summaryrefslogtreecommitdiff
path: root/internal/module/oauth/README.md
diff options
context:
space:
mode:
authorLibravatar Tobi Smethurst <31960611+tsmethurst@users.noreply.github.com>2021-03-22 22:26:54 +0100
committerLibravatar GitHub <noreply@github.com>2021-03-22 22:26:54 +0100
commitaa9ce272dcfa1380b2f05bc3a90ef8ca1b0a7f62 (patch)
treef3e01f5434a2f90007969373f0fa32dc855207c7 /internal/module/oauth/README.md
parentfix lint errors (diff)
downloadgotosocial-aa9ce272dcfa1380b2f05bc3a90ef8ca1b0a7f62.tar.xz
Oauth/token (#7)
* add host and protocol options * some fiddling * tidying up and comments * tick off /oauth/token * tidying a bit * tidying * go mod tidy * allow attaching middleware to server * add middleware * more user friendly * add comments * comments * store account + app * tidying * lots of restructuring * lint + tidy
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.