add some support for tickets, introspection method, minor fixes

[squeep-indieauth-helper] / README.md

diff --git a/README.md b/README.md
index dee619d5bdf2c32e5332f2581e0e5888dd062b47..fe3e36296cee72e413ba9d4b382c4a24c0f1a0ba 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,17 +1,37 @@
 # IndieAuth Helper
 
-Just some abstractions for interacting with IndieAuth sites.
+Just some abstractions for interacting with IndieAuth sites, basically wrapping axios and mf2 parsing.
+
+This is currently quite opinionated, and likely is only really useful in the context of Squeep Framework Applications.
 
 Notable methods on the Communication class:
 
-- static generatePKCE(length)  
+- `static async generatePKCE(length)`  
   Create a code and verifier for use in an IndieAuth transaction.
 
-- fetchProfile(urlObject)  
+- `validateProfile(url)`
+  Check that a urls meets specification requirements to be a profile.
+
+- `async fetchProfile(urlObject)`  
   Retrieve profile information from an endpoint.
 
-- fetchClientIdentifier(urlObject)  
+- `async validateClientIdentifier(url)`
+  Check that a url meets specification requirements to be a client identifier.
+
+- `async fetchClientIdentifier(urlObject)`  
   Retrieve client identifier information from an endpoint.
 
-- fetchMicroformat(urlObject)  
-  Retrieve all mf2 information form an endpoint.
+- `async fetchMicroformat(urlObject)`  
+  Retrieve all mf2 information from an endpoint.
+
+- `async fetchJSON(urlObject)`  
+  Retrieve json from an endpoint.
+
+- `async redeemProfileCode(urlObj, code, codeVerifier, clientId, redirectURI)`
+  Submit a code to get a profile response.
+
+- `async introspectToken(introspectionUrlObj, authenticationHeader, token)`
+  Submit a token for introspection.
+
+- `async deliverTicket(ticketEndpointUrlObj, resourceUrlObj, subjectUrlObj, ticket)`
+  Submit a ticket offer.