initial commit

[squeep-indieauth-helper] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..dee619d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# IndieAuth Helper
+
+Just some abstractions for interacting with IndieAuth sites.
+
+Notable methods on the Communication class:
+
+- static generatePKCE(length)  
+  Create a code and verifier for use in an IndieAuth transaction.
+
+- fetchProfile(urlObject)  
+  Retrieve profile information from an endpoint.
+
+- fetchClientIdentifier(urlObject)  
+  Retrieve client identifier information from an endpoint.
+
+- fetchMicroformat(urlObject)  
+  Retrieve all mf2 information form an endpoint.