aboutsummaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authormarty hiatt <martianhiatus [a t] riseup [d o t] net>2023-08-31 12:10:48 +0200
committermarty hiatt <martianhiatus [a t] riseup [d o t] net>2023-08-31 12:12:05 +0200
commitd4c105cc39315de3c9f3f29b97de0c0dec718770 (patch)
tree32c353f12cd9a4493bcd8de38c7560406144a153 /README.org
parent42bf0c5d4f1b81f8468ac774a5d7f19057510b32 (diff)
add ELPA to readme/info
Diffstat (limited to 'README.org')
-rw-r--r--README.org38
1 files changed, 25 insertions, 13 deletions
diff --git a/README.org b/README.org
index dd00f74..290caea 100644
--- a/README.org
+++ b/README.org
@@ -13,23 +13,15 @@ implement the Mastodon API. For info see [[https://joinmastodon.org/][joinmastod
** Installation
-Clone this repository and add the lisp directory to your load path.
-Then, require it and go.
+You can install =mastodon.el= from ELPA, MELPA, or directly from this repo.
-#+BEGIN_SRC emacs-lisp
- (add-to-list 'load-path "/path/to/mastodon.el/lisp")
- (require 'mastodon)
-#+END_SRC
+*** ELPA
-Or, with =use-package=:
+You should be able to directly install with:
-#+BEGIN_SRC emacs-lisp
- (use-package mastodon
- :ensure t)
-#+END_SRC
+=M-x package-refresh-contents RET=
-The minimum Emacs version is now 27.1. But if you are running an older version
-it shouldn't be very hard to get it working.
+=M-x package-install RET mastodon RET=
*** MELPA
@@ -47,6 +39,26 @@ Update and install:
=M-x package-install RET mastodon RET=
+*** Repo
+
+Clone this repository and add the lisp directory to your load path.
+Then, require it and go.
+
+#+BEGIN_SRC emacs-lisp
+ (add-to-list 'load-path "/path/to/mastodon.el/lisp")
+ (require 'mastodon)
+#+END_SRC
+
+Or, with =use-package=:
+
+#+BEGIN_SRC emacs-lisp
+ (use-package mastodon
+ :ensure t)
+#+END_SRC
+
+The minimum Emacs version is now 27.1. But if you are running an older version
+it shouldn't be very hard to get it working.
+
*** Emoji
=mastodon-mode= will enable [[https://github.com/iqbalansari/emacs-emojify][Emojify]] if it is loaded in your Emacs environment, so