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