branch: elpa/fedi
commit 132f7aeec8fc2f76869fd4708538b2efaa7ec325
Author: marty hiatt <martianhiatus [a t] riseup [d o t] net>
Commit: marty hiatt <martianhiatus [a t] riseup [d o t] net>
readme
---
readme.org | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/readme.org b/readme.org
new file mode 100644
index 00000000000..ab1c55e8a5d
--- /dev/null
+++ b/readme.org
@@ -0,0 +1,11 @@
+* fedi.el
+
+A library to make writing clients for APIs easier.
+
+This is a WIP mess, with code taken from mastodon.el. It will be cleaned up,
and made less convoluted, but it's already useable.
+
+The macro =fedi-request= allows you to quickly create HTTP request commands to
endpoints provided, with parameters sent as form data or JSON payloads (for
POST, PUT, probably PATCH).
+
+If you want to incorporate your service's authentication methods, you may find
it easier to copy the macro and incorporate the auth work into it, so you don't
need to include it in every request.
+
+For an example of using this library, see my
[[https://codeberg.org/martianh/lem][lem]] repo.