Skip to content

Commit 9dc1cb6

Browse files
committed
Add MELPA badge and installation instructions
1 parent 598766a commit 9dc1cb6

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

README.org

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
* Signel
2+
[[https://www.gnu.org/licenses/gpl-3.0][file:https://img.shields.io/badge/License-GPLv3-blue.svg]] [[https://melpa.org/#/signel][file:https://melpa.org/packages/signel-badge.svg]]
23

34
Signel is an Emacs interface for [[https://signal.org][Signal]]. It communicates with a running
45
~signal-cli~ daemon via JSON-RPC to send and receive messages.
@@ -28,14 +29,23 @@ signal-cli link -n "emacs-client" | xargs -n 1 qrencode -t utf8
2829
#+end_src
2930

3031
** Installation
32+
~signel~ is available on [[https://melpa.org][MELPA]].
3133

32-
Clone the repository and add it to your load path.
34+
You can install ~signel~ with the following command.
3335

34-
*** use-package
36+
#+begin_src
37+
M-x package-install RET signel RET
38+
#+end_src
39+
40+
For a basic configuration, place this in your ~user-init-file~
3541

36-
#+begin_src elisp
42+
#+begin_src emacs-lisp
43+
(setq signel-account "+15550000000")
44+
#+end_src
45+
46+
*** use-package
47+
#+begin_src emacs-lisp
3748
(use-package signel
38-
:load-path "~/.emacs.d/site-lisp/signel" ;; Adjust path as needed
3949
:config
4050
;; REQUIRED: Your registered phone number
4151
(setq signel-account "+15550000000")

0 commit comments

Comments
 (0)