summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThomas F. K. Jorna <[email protected]>2021-07-31 21:32:14 +0200
committerGitHub <[email protected]>2021-07-31 21:32:14 +0200
commit9bef309b47dae09275634355ca308d62fc3cffb1 (patch)
tree6bbaf983cfc6bffc24109d7944ae6905246facb3
parenta32bc066eeafa004a30c7f1a71322504105c5fd5 (diff)
straight usepackage instructions
-rw-r--r--README.md12
1 files changed, 9 insertions, 3 deletions
diff --git a/README.md b/README.md
index 76946a4..5c71279 100644
--- a/README.md
+++ b/README.md
@@ -64,14 +64,20 @@ Then something along the following to your `config.el`
We recommend only loading org-roam-ui after loading org(-roam) as starting the server and making database requests can impact startup times quite a lot.
-### Quelpa/use-package
-
+### straight/use-package
+```emacs-lisp
+(use-package org-roam-ui
+ :straight
+ (:host github :repo "org-roam/org-roam-ui" :branch "main" :files ("*.el" "out"))
+ :after org-roam
+ :hook (org-roam . org-roam-ui-mode))
+```
TODO
You probably know how to do this
## Usage
-Use `M-x org-roam-ui RET` to enable the global mode.
+Use `M-x org-roam-ui-mode RET` to enable the global mode.
It will start a web server on http://127.0.0.1:35901/ and connect to it via a WebSocket for real-time updates.
### Commands