From d90d10741b1dde17eca4b4fd0b034d37d52d5dc0 Mon Sep 17 00:00:00 2001 From: Jeremy Dormitzer Date: Mon, 20 Aug 2018 10:20:07 -0400 Subject: Make default visibility customizable; add documentation. --- README.org | 33 ++++++++++++++++++--------------- 1 file changed, 18 insertions(+), 15 deletions(-) diff --git a/README.org b/README.org index 9eb7e52..5a01753 100644 --- a/README.org +++ b/README.org @@ -1,4 +1,4 @@ -* mastodon.el +* mastodon.el [[https://melpa.org/#/mastodon][file:https://melpa.org/packages/mastodon-badge.svg]] @@ -49,7 +49,7 @@ there's no need to write your own hook anymore. =emojify-mode= is not required. *** Discover -=mastodon-mode= will provide a context menu for its keybindings if [[https://github.com/mickeynp/discover.el][Discover]] is +=mastodon-mode= will provide a context menu for its keybindings if [[https://github.com/mickeynp/discover.el][Discover]] is installed. It is not required. ** Usage @@ -126,29 +126,32 @@ Opens a =*mastodon-home*= buffer in the major mode so you can see toots. You wil =M-x mastodon-toot= Pops a new buffer/window with a =mastodon-toot= minor mode. Enter the -contents of your toot here. =C-c C-c= sends the toot. =C-c C-k= cancels. +contents of your toot here. =C-c C-c= sends the toot. =C-c C-k= cancels. Both actions kill the buffer and window. If you have not previously authenticated, you will be prompted for your account email and password. *NOTE*: Email and password are NOT stored by mastodon.el. -Authentication stores your access token in the =mastodon-auth--token= -variable. It is not stored on your filesystem, so you will have to +Authentication stores your access token in the =mastodon-auth--token= +variable. It is not stored on your filesystem, so you will have to re-authenticate when you close/reopen Emacs. -The visibility of the new toot defaults to the value of -=mastodon-toot--default-visibility= which you can customize. +**** Customization +The default toot visibility can be changed by setting or customizing the =mastodon-toot--default-visibility= variable. Valid values are ="public"=, ="unlisted"=, ="private"=, or =direct=. + +Toot visibility can also be changed on a per-toot basis from the new toot buffer. **** Keybindings -|-----------+---------------------------------------| -| Key | Action | -|-----------+---------------------------------------| -| =C-c C-c= | Send toot | -| =C-c C-k= | Cancel toot | -| =C-c C-w= | Add content warning | -| =C-c C-v= | Change the visibility of the new toot | -|-----------+---------------------------------------| +|-----------+------------------------| +| Key | Action | +|-----------+------------------------| +| =C-c C-c= | Send toot | +| =C-c C-k= | Cancel toot | +| =C-c C-w= | Add content warning | +| =C-c C-v= | Change toot visibility | +|-----------+------------------------| +>>>>>>> Make default visibility customizable; add documentation. ** Roadmap -- cgit v1.2.3