X-Git-Url: https://git.squeep.com/?a=blobdiff_plain;f=README.md;h=47c8cc6fc5ba8637f9e8cd610478f70233348c71;hb=cc52f66ba8522b6bc7002dfba79c1162a51aef0e;hp=985c6b0356de83f02310c9d4b613824d0e62cf7f;hpb=1c4bb7e3bbdc1121ceba373c5be4459521197155;p=squeep-indieauth-helper diff --git a/README.md b/README.md index 985c6b0..47c8cc6 100644 --- 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.