update dependencies and devDependencies

[squeep-indieauth-helper] / README.md

diff --git a/README.md b/README.md
index fe3e36296cee72e413ba9d4b382c4a24c0f1a0ba..b3f85bf3bc1063f9d397694852c5459ccdd9c7ac 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 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,8 +27,8 @@ 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.