branch: elpa/fedi
commit c8d5fce21c6ef39894ea86b9c8885fdd955faf44
Author: marty hiatt <martianhiatus [a t] riseup [d o t] net>
Commit: marty hiatt <martianhiatus [a t] riseup [d o t] net>
readme re -post.el
---
readme.org | 20 ++++++++++++++++----
1 file changed, 16 insertions(+), 4 deletions(-)
diff --git a/readme.org b/readme.org
index 124f6488ca3..14d7c616bfa 100644
--- a/readme.org
+++ b/readme.org
@@ -3,13 +3,16 @@
A library to make writing clients for APIs easier.
It uses code from my
[[https://codeberg.org/martianh/mastodon.el][mastodon.el]] to make it easy to
write endpoint-hitting
-functions for JSON APIs.
+functions for JSON APIs, and to easily build interfaces.
* http layer
The example macro =fedi-request= allows you to quickly create HTTP request
commands to API endpoints, with parameters automatically constructed and sent
-as form data or JSON payloads (for POST, PUT, DELETE, and probably PATCH). You
should write your own similar macro in your package. See my =lem.el= for an
working example. That way you can handle package-specific parameters such as
authentication.
+as form data or JSON payloads (for POST, PUT, DELETE, and probably PATCH). You
+should write your own similar macro in your package. See my =lem.el= for a
+working example. That way you can handle package-specific parameters such as
+authentication.
Responses are checked with =fedi-http--triage=, and processed with
=fedi-http--process-response=. If a response returns HTML (i.e. for a 404), it
@@ -19,8 +22,17 @@ Because of how =mastodon.el= works, there is also code for
handling link headers
in responses. Mastodon uses these for pagination in some cases. If your
service also does, you can handle them too.
-For an example of using this library, see my
[[https://codeberg.org/martianh/lem][lem]] repo.
+For an example of using this library, see my
[[https://codeberg.org/martianh/lem.el][lem.el]] repo.
* utilities
-=fedi.el= contains some utility functions for setting up a new client buffer,
navigating between items, displaying icons, webfinger lookup of URLs, and
live-updating timestamps. More will be added as they are ported from
=mastodon.el=.
+=fedi.el= contains some utility functions for setting up a new client buffer,
+navigating between items, displaying icons, webfinger lookup of URLs, and
+live-updating timestamps. More will be added as they are ported from
+=mastodon.el=.
+
+* posting
+
+=fedi-post.el= contains functions for rich composing of posts. It supports
+pretty display of available bindings, toggling post flags like NSWF, and
+completion of items like handles and tags.
