aboutsummaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authormarty hiatt <martianhiatus [a t] riseup [d o t] net>2022-11-19 11:15:20 +0100
committermarty hiatt <martianhiatus [a t] riseup [d o t] net>2022-11-19 11:15:20 +0100
commita9f0e504cf441db0fd311141c1a9433cf9a46be7 (patch)
tree117c930fc6fe761b6e7db24dbd7423307de57f0f /README.org
parentecaf47eac07c94781dc7e4e48a89d223917f832e (diff)
parent653bf0e90b5f1b281d689f2411fda16876df0c0b (diff)
Merge branch 'develop' into lists
Diffstat (limited to 'README.org')
-rw-r--r--README.org50
1 files changed, 23 insertions, 27 deletions
diff --git a/README.org b/README.org
index ffe65df..2684baa 100644
--- a/README.org
+++ b/README.org
@@ -122,6 +122,7 @@ take place if your =mastodon-token-file= does not contain =:client_id= and
| =H= | Open home timeline |
| =L= | Open local timeline |
| =N= | Open notifications timeline |
+| =@= | Open mentions-only notifications timeline |
| =u= | Update current timeline |
| =T= | Open thread for toot under =point= |
| =#= | Prompt for tag and open its timeline |
@@ -155,6 +156,7 @@ take place if your =mastodon-token-file= does not contain =:client_id= and
|---------------+-----------------------------------------------------------------------|
| | Notifications view |
| =a=, =j= | accept/reject follow request |
+| =c= | clear notification at point |
|---------------+-----------------------------------------------------------------------|
| | *Quitting* |
| =q= | Quit mastodon buffer, leave window open |
@@ -209,27 +211,27 @@ You can download and use your instance's custom emoji
**** 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.
-- =mastodon-toot-open-draft-toot=: Open a compose buffer and insert one of your draft toots.
-- =mastodon-toot-delete-draft-toot=: Delete a draft toot.
-- =mastodon-toot-delete-all-drafts=: Delete all your drafts.
+- =mastodon-toot--save-draft=: save the current toot as a draft.
+- =mastodon-toot--open-draft-toot=: Open a compose buffer and insert one of your draft toots.
+- =mastodon-toot--delete-draft-toot=: Delete a draft toot.
+- =mastodon-toot--delete-all-drafts=: Delete all your drafts.
*** Other commands and account settings:
- =mastodon-url-lookup=: Attempt to load URL in =mastodon.el=. URL may be the one at point or provided in the minibuffer. Should also work if =mastodon.el= is not yet loaded.
-- =mastodon-tl-view-instance-description=: View information about the instance that the author of the toot at point is on.
-- =mastodon-tl-view-own-instance=: View information about your own instance.
-- =mastodon-search-trending-tags=: View a list of trending hashtags on your instance.
+- =mastodon-tl--view-instance-description=: View information about the instance that the author of the toot at point is on.
+- =mastodon-tl--view-own-instance=: View information about your own instance.
+- =mastodon-search--trending-tags=: View a list of trending hashtags on your instance.
-- =mastodon-profile-update-display-name=: Update the display name for your account.
-- =mastodon-profile-update-user-profile-note=: Update your bio note.
-- =mastodon-profile-update-meta-fields=: Update your metadata fields.
-- =mastodon-profile-set-default-toot-visibility=: Set the default visibility for your toots.
-- =mastodon-profile-account-locked-toggle=: Toggle the locked status of your account. Locked accounts have to manually approve follow requests.
-- =mastodon-profile-account-discoverable-toggle=: Toggle the discoverable status of your account. Non-discoverable accounts are not listed in the profile directory.
-- =mastodon-profile-account-bot-toggle=: Toggle whether your account is flagged as a bot.
-- =mastodon-profile-account-sensitive-toggle=: Toggle whether your posts are marked as sensitive (nsfw) by default.
+- =mastodon-profile--update-display-name=: Update the display name for your account.
+- =mastodon-profile--update-user-profile-note=: Update your bio note.
+- =mastodon-profile--update-meta-fields=: Update your metadata fields.
+- =mastodon-profile--set-default-toot-visibility=: Set the default visibility for your toots.
+- =mastodon-profile--account-locked-toggle=: Toggle the locked status of your account. Locked accounts have to manually approve follow requests.
+- =mastodon-profile--account-discoverable-toggle=: Toggle the discoverable status of your account. Non-discoverable accounts are not listed in the profile directory.
+- =mastodon-profile--account-bot-toggle=: Toggle whether your account is flagged as a bot.
+- =mastodon-profile--account-sensitive-toggle=: Toggle whether your posts are marked as sensitive (nsfw) by default.
*** Customization
@@ -255,7 +257,7 @@ See =M-x customize-group RET mastodon= to view all customize options.
Works for federated, local, and home timelines and for notifications. It's a
little touchy, one thing to avoid is trying to load a timeline more than once
at a time. It can go off the rails a bit, but it's still pretty cool. The
-current maintainer of =mastodon.el= is unable to debug improve this feature.
+current maintainer of =mastodon.el= is unable to debug or improve this feature.
To enable, it, add =(require 'mastodon-async)= to your =init.el=. Then you can
view a timeline with one of the commands that begin with
@@ -297,19 +299,11 @@ Optional dependencies:
- =mpv= and =mpv.el= for viewing videos and gifs
- =lingva.el= for translating toots
-** Nota Bene regarding work on this library
-
-I resurrected this library a few years ago, and have added stacks of features and fixes over time. I do it in my spare time and tend to implement features I want to use. I am not a professional programmer. I never aimed to implement all Mastodon features, nor to provide a professional service to others. I have implemented some things I don't use, such as filters, but mostly I can only fix bugs with things that I regularly rely on.
-
-Please keep this in mind when requesting features that are not implemented. Feel free to open an issue and start a discussion, but don't try to order things from me.
-
-The better option is to look at the code and seeing how you can implement the feature yourself. A lot of the functionality you'll need is already implemented. I'm happy to give pointers on what you might use.
-
** Contributing
PRs, issues, feature requests, and general feedback are very welcome!
-*** Bugs
+*** Bug reports
1. =mastodon.el= has bugs, as well as lots of room for improvement.
2. I receive very little feedback, so if I don't run into the bug it often doesn't get fixed.
@@ -321,13 +315,15 @@ PRs, issues, feature requests, and general feedback are very welcome!
1. Create an [[https://github.com/jdenen/mastodon.el/issues][issue]] detailing the feature you'd like to add.
2. Fork the repository and create a branch off of =develop=.
-3. Create a pull request referencing the issue created in step 1.
+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.
*** Fixes
1. In an [[https://github.com/jdenen/mastodon.el/issues][issue]], let me know that you're working to fix it.
2. Fork the repository and create a branch off of =develop=.
-3. Create a pull request referencing the issue from step 1.
+3. Run the tests and ensure that your code doesn't break any of them.
+4. Create a pull request referencing the issue from step 1.
** Contributors: