X-Git-Url: http://git.squeep.com/?p=squeep-indieauth-helper;a=blobdiff_plain;f=README.md;fp=README.md;h=9a67a6d2ffa05db8463c89820d08ec8e1cabdb49;hp=b3f85bf3bc1063f9d397694852c5459ccdd9c7ac;hb=45d151c0587750c9a8ed3e3180ca79139a6ccb5e;hpb=1d9686ba6995243a939f9438045f92e7573e9b85 diff --git a/README.md b/README.md index b3f85bf..9a67a6d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # IndieAuth Helper -Just some abstractions for interacting with IndieAuth sites, basically wrapping `got` and `microformats-parser` mf2 parsing and some other fiddly bits. +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. @@ -35,3 +35,6 @@ Notable methods on the Communication class: - `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.