X-Git-Url: http://git.squeep.com/?p=squeep-indieauth-helper;a=blobdiff_plain;f=README.md;h=bd005a7e83b23355752f82d1e78e9e0d6845d93c;hp=dee619d5bdf2c32e5332f2581e0e5888dd062b47;hb=8daa668e5a0485b5f0e2b07203d9fb237d7f761c;hpb=a15c4051aee22b76eca268e6a53b0944a9e40d0c diff --git a/README.md b/README.md index dee619d..bd005a7 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,17 @@ Just some abstractions for interacting with IndieAuth sites. Notable methods on the Communication class: -- static generatePKCE(length) +- `static async generatePKCE(length)` Create a code and verifier for use in an IndieAuth transaction. -- fetchProfile(urlObject) +- `async fetchProfile(urlObject)` Retrieve profile information from an endpoint. -- fetchClientIdentifier(urlObject) +- `async fetchClientIdentifier(urlObject)` Retrieve client identifier information from an endpoint. -- fetchMicroformat(urlObject) - Retrieve all mf2 information form an endpoint. +- `async fetchMicroformat(urlObject)` + Retrieve all mf2 information from an endpoint. + +- `async fetchJSON(urlObject)` + Retrieve json from an endpoint.