switch from axios to got package for client requests
[squeep-indieauth-helper] / README.md
index 985c6b0356de83f02310c9d4b613824d0e62cf7f..47c8cc6fc5ba8637f9e8cd610478f70233348c71 100644 (file)
--- a/README.md
+++ b/README.md
@@ -9,9 +9,15 @@ Notable methods on the Communication class:
 - `static async generatePKCE(length)`  
   Create a code and verifier for use in an IndieAuth transaction.
 
+- `validateProfile(url)`
+  Check that a urls meets specification requirements to be a profile.
+
 - `async fetchProfile(urlObject)`  
   Retrieve profile information from an endpoint.
 
+- `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.
 
@@ -20,3 +26,12 @@ Notable methods on the Communication class:
 
 - `async fetchJSON(urlObject)`  
   Retrieve json from an endpoint.
+
+- `async redeemCode(urlObj, code, codeVerifier, clientId, redirectURI)`
+  Submit a code to get a profile or ticket response.
+
+- `async introspectToken(introspectionUrlObj, authenticationHeader, token)`
+  Submit a token for introspection.
+
+- `async deliverTicket(ticketEndpointUrlObj, resourceUrlObj, subjectUrlObj, ticket)`
+  Submit a ticket offer.