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.6
[squeep-indieauth-helper]
/
README.md
diff --git
a/README.md
b/README.md
index bd005a7e83b23355752f82d1e78e9e0d6845d93c..e2df28d1b7e24391845b58cbd588c4661d2d226c 100644
(file)
--- a/
README.md
+++ b/
README.md
@@
-1,6
+1,8
@@
# 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:
@@
-10,6
+12,9
@@
Notable methods on the Communication class:
- `async fetchProfile(urlObject)`
Retrieve profile information from an endpoint.
- `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.
- `async fetchClientIdentifier(urlObject)`
Retrieve client identifier information from an endpoint.