X-Git-Url: http://git.squeep.com/?a=blobdiff_plain;f=README.md;h=e2df28d1b7e24391845b58cbd588c4661d2d226c;hb=92b0d18597c3dc659182adec495f1d4b972f2f3e;hp=bd005a7e83b23355752f82d1e78e9e0d6845d93c;hpb=8daa668e5a0485b5f0e2b07203d9fb237d7f761c;p=squeep-indieauth-helper diff --git a/README.md b/README.md index bd005a7..e2df28d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # IndieAuth Helper -Just some abstractions for interacting with IndieAuth sites. +Just some abstractions for interacting with IndieAuth sites, basically wrapping axios and mf2 parsing. + +This is currently quite opinionated, and likely is only really useful in the context of Squeep Framework Applications. Notable methods on the Communication class: @@ -10,6 +12,9 @@ Notable methods on the Communication class: - `async fetchProfile(urlObject)` Retrieve profile information from an endpoint. +- `async validateClientIdentifier(url)` + Check that a url meets specification requirements to be a client identifier. + - `async fetchClientIdentifier(urlObject)` Retrieve client identifier information from an endpoint.