summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..069d3e7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# jesterpm-sso-tools
+
+Utilities for working with OAuth2 / IndieAuth endpoints.
+
+I built this specifically for working with my own OAuth2 provider, but it could
+reasonably work with any provider that supports the OAuth device flow.
+
+## Usage
+
+Usage: sso [OPTIONS] [COMMAND] [ARGS]
+
+Options:
+ --scope <SCOPE> Request an additional scope
+ --endpoint <URL> The jesterpm-sso endpoint
+
+Commands:
+ login - default: get or renew an access token
+ curl - pass the access token to curl