Skip to content

Commit

Permalink
Update readme, add melpa
Browse files Browse the repository at this point in the history
  • Loading branch information
goktug97 committed May 17, 2020
1 parent 6b371e3 commit d47976f
Showing 1 changed file with 19 additions and 16 deletions.
35 changes: 19 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 <path-to-org-roam-server-folder>)
: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`

Expand Down

0 comments on commit d47976f

Please sign in to comment.