bump package version to 1.4.2

[squeep-indieauth-helper] / README.md

diff --git a/README.md b/README.md
index fe3e36296cee72e413ba9d4b382c4a24c0f1a0ba..9a67a6d2ffa05db8463c89820d08ec8e1cabdb49 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # IndieAuth Helper
 
-Just some abstractions for interacting with IndieAuth sites, basically wrapping axios and mf2 parsing.
+Just some abstractions for interacting with IndieAuth sites, basically wrapping `got` and `microformats-parser` mf2 parsing, performing various validations according to the specification, and some other fiddly bits.
 
 This is currently quite opinionated, and likely is only really useful in the context of Squeep Framework Applications.
 
@@ -9,8 +9,8 @@ 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 validateProfile(url)`
+  Check that a url meets specification requirements to be a profile.
 
 - `async fetchProfile(urlObject)`  
   Retrieve profile information from an endpoint.
@@ -27,11 +27,14 @@ Notable methods on the Communication class:
 - `async fetchJSON(urlObject)`  
   Retrieve json from an endpoint.
 
-- `async redeemProfileCode(urlObj, code, codeVerifier, clientId, redirectURI)`
-  Submit a code to get a profile response.
+- `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.
+
+- `async redeemTicket(ticket, resourceUrlObj, issuerUrlObj)`
+  Exchange a ticket for an access token to the given resource.