diff --git a/README.md b/README.md index 93de09b..828d649 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,37 @@ org-roam-server =================================== +![License](https://img.shields.io/github/license/org-roam/org-roam-server) +![Release](https://img.shields.io/github/v/release/org-roam/org-roam-server) +[![MELPA](https://melpa.org/packages/org-roam-server-badge.svg)](https://melpa.org/#/org-roam-server) ![Graph](https://raw.githubusercontent.com/goktug97/org-roam-server/master/org-roam-server.gif) -## Requirements +## Installation -- [org-roam](https://github.com/jethrokuan/org-roam) -- [simple-httpd](https://github.com/skeeto/emacs-web-server/) - -## use-package - -```bash -git clone https://github.com/goktug97/org-roam-server -``` +`org-roam-server` is on MELPA. You can directly install from there. ```elisp (use-package org-roam-server - :ensure nil - :load-path ) + :ensure t) ``` ## Usage Use `M-x org-roam-server-mode RET` to enable the global mode. -It will start a web server on http://127.0.0.1:8080/ +It will start a web server on http://127.0.0.1:8080/. + +Although it will automatically reload if there is a change in the +database, sometimes it fails to establish a connection. If it does not +reload after `org-roam-build-cache`, you can do it manually by +clicking the `reload` button which will reload the data, rebuild the +graph and refresh connections. + +## Org-Roam Protocol +The graph utilizes org-roam protocol. Which means if you click on one of the nodes, +it will open the corresponding file in Emacs. For this future to work, org-roam protocol +should be configured in the system. -## Clickable Graph -The graph uses org-roam protocol which means if you click one of the nodes -it opens the org file. For it to work, you should set up the org-roam protocol; -https://org-roam.readthedocs.io/en/develop/roam_protocol/ +[Configuring Org-Roam Protocol](https://org-roam.readthedocs.io/en/develop/roam_protocol/) Also make sure the emacs server is started; `M-x server-start RET`