Small README update

This commit is contained in:
Lucien Cartier-Tilet 2022-03-02 18:04:46 +01:00
parent 1544945ac9
commit c8c11a5eeb
Signed by: phundrak
GPG Key ID: BD7789E705CB8DCA

View File

@ -10,6 +10,8 @@ Most of its public function are transient functions from the
transient library to provide the user an easy-to-use interface with transient library to provide the user an easy-to-use interface with
most of its options exposed. most of its options exposed.
This package is still very much a work in progress. Use at your own
risks.
* Table of Contents :TOC_2_gh: * Table of Contents :TOC_2_gh:
- [[#introduction][Introduction]] - [[#introduction][Introduction]]
@ -26,17 +28,17 @@ A couple of options are available for installing bitwarden.el.
The first one is to clone the repository in your ~load-path~ and add the The first one is to clone the repository in your ~load-path~ and add the
following to your ~.emacs~ or your ~init.el~: following to your ~.emacs~ or your ~init.el~:
#+begin_src emacs-lisp #+begin_src emacs-lisp
(require 'bitwarden.el) (require 'bitwarden.el)
#+end_src #+end_src
In my case, I prefer using ~use-package~ with ~straight~: In my case, I prefer using ~use-package~ with ~straight~:
#+begin_src emacs-lisp #+begin_src emacs-lisp
(use-package bitwarden (use-package bitwarden
:ensure t :ensure t
:defer t :defer t
:straight (bitwarden :type git :straight (bitwarden :type git
:host nil :host nil
:repo "https://labs.phundrak.com/phundrak/bitwarden.el")) :repo "https://labs.phundrak.com/phundrak/bitwarden.el"))
#+end_src #+end_src
I personally also added ~:build t~ in the straight recipe to ensure I personally also added ~:build t~ in the straight recipe to ensure