minor doc fixes

[squeep-indieauth-helper] / README.md

diff --git a/README.md b/README.md
index e2df28d1b7e24391845b58cbd588c4661d2d226c..b3f85bf3bc1063f9d397694852c5459ccdd9c7ac 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # IndieAuth Helper
 
 # 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 and some other fiddly bits.

 
 This is currently quite opinionated, and likely is only really useful in the context of Squeep Framework Applications.
 
 
 This is currently quite opinionated, and likely is only really useful in the context of Squeep Framework Applications.
 


@@ -9,6 +9,9 @@ Notable methods on the Communication class:
 - `static async generatePKCE(length)`  
   Create a code and verifier for use in an IndieAuth transaction.
 
 - `static async generatePKCE(length)`  
   Create a code and verifier for use in an IndieAuth transaction.
 

+- `async validateProfile(url)`
+  Check that a url meets specification requirements to be a profile.
+

 - `async fetchProfile(urlObject)`  
   Retrieve profile information from an endpoint.
 
 - `async fetchProfile(urlObject)`  
   Retrieve profile information from an endpoint.
 


@@ -23,3 +26,12 @@ Notable methods on the Communication class:
 
 - `async fetchJSON(urlObject)`  
   Retrieve json from an endpoint.
 
 - `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.