aboutsummaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authormarty hiatt <martianhiatus [a t] riseup [d o t] net>2023-01-15 18:05:46 +0100
committermarty hiatt <martianhiatus [a t] riseup [d o t] net>2023-01-15 18:08:07 +0100
commitdefb84daea4fe52b06fa21759c8c2b221bb6db0e (patch)
tree6ab9c4f37387679fc595f52f80c9bc92fccbd458 /README.org
parentc366effc9b602f7d5c5e0fdf37233c83f5028e08 (diff)
readme - show toc
Diffstat (limited to 'README.org')
-rw-r--r--README.org12
1 files changed, 5 insertions, 7 deletions
diff --git a/README.org b/README.org
index 05f80fa..efea201 100644
--- a/README.org
+++ b/README.org
@@ -1,5 +1,3 @@
-#+OPTIONS: toc:nil
-
@@html: <a href="https://melpa.org/#/mastodon"><img alt="MELPA" src="https://melpa.org/packages/mastodon-badge.svg"/></a>@@
@@html: <a href="https://ci.codeberg.org/martianh/mastodon.el"><img alt="Build Status" src="https://ci.codeberg.org/api/badges/martianh/mastodon.el/status.svg"></a>@@
@@ -217,7 +215,7 @@ You can download and use your instance's custom emoji
| =C-c C-l= | Set toot language |
|---------+----------------------------------|
-**** draft toots
+**** Draft toots
- Compose buffer text is saved as you type, kept in =mastodon-toot-current-toot-text=.
- =mastodon-toot--save-draft=: save the current toot as a draft.
@@ -336,7 +334,7 @@ Optional dependencies:
- =mpv= and =mpv.el= for viewing videos and gifs
- =lingva.el= for translating toots
-** Network compatibility.
+** Network compatibility
=mastodon.el= should work with ActivityPub servers that implement the Mastodon API.
@@ -367,14 +365,14 @@ PRs, issues, feature requests, and general feedback are very welcome!
3. Run the tests and ensure that your code doesn't break any of them.
4. Create a pull request referencing the issue created in step 1.
-*** coding style
+*** Coding style
- This library uses an unconvential double dash (=--=) between file namespaces and function names, which contradicts normal Elisp style. This needs to be respected until the whole library is changed.
- Use =aggressive-indent-mode= or similar to keep your code indented.
- Single spaces end sentences in docstrings.
- There's no need for a blank line after the first docstring line (one is added automatically when documentation is displayed).
-** Supporting mastodon.el
+** Supporting =mastodon.el=
If you'd like to support continued development of =mastodon.el=, I accept
donations via paypal: https://paypal.me/martianh. If you would
@@ -383,7 +381,7 @@ provide IBAN or other details.
I don't have a tech worker's income, so even a small tip would help out.
-** Contributors:
+** Contributors
=mastodon.el= is the work of a number of people.