projects
/
squeep-indieauth-helper
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
bump package version to 1.1.7
[squeep-indieauth-helper]
/
README.md
diff --git
a/README.md
b/README.md
index dee619d5bdf2c32e5332f2581e0e5888dd062b47..e2df28d1b7e24391845b58cbd588c4661d2d226c 100644
(file)
--- a/
README.md
+++ b/
README.md
@@
-1,17
+1,25
@@
# IndieAuth Helper
# 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:
Notable methods on the Communication class:
--
static generatePKCE(length)
+-
`static async generatePKCE(length)`
Create a code and verifier for use in an IndieAuth transaction.
Create a code and verifier for use in an IndieAuth transaction.
--
fetchProfile(urlObject)
+-
`async fetchProfile(urlObject)`
Retrieve profile information from an endpoint.
Retrieve profile information from an endpoint.
-- fetchClientIdentifier(urlObject)
+- `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.
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.