(release): v1.0.0 (#341)

This commit is contained in:
Jethro Kuan
2020-03-23 15:34:21 +08:00
committed by GitHub
parent def3d27d25
commit 1433dbc316
4 changed files with 46 additions and 71 deletions

View File

@ -1,6 +1,7 @@
[![License GPL 3][badge-license]](http://www.gnu.org/licenses/gpl-3.0.txt)
[![Documentation Status](https://readthedocs.org/projects/org-roam/badge/?version=latest)](https://org-roam.readthedocs.io/en/latest/?badge=latest)
[![GitHub Release](https://img.shields.io/github/v/release/jethrokuan/org-roam)](https://img.shields.io/github/v/release/jethrokuan/org-roam)
[![MELPA](https://melpa.org/packages/org-roam-badge.svg)](https://melpa.org/#/org-roam)
## Synopsis
@ -22,6 +23,7 @@ Important links:
- **[Documentation][docs]**
- **[Org-roam Slack][slack]**
## A Preview
Here's a screenshot of `org-roam`. The `org-roam` buffer shows
@ -34,13 +36,18 @@ structure, and can be used to navigate to the respective files.
## Installation
The recommended method is using use-package and straight, or a similar package manager.
You can install `org-roam` using `package.el`:
```
M-x package-install RET org-roam RET
```
Here's a sample configuration with using `use-package`:
```emacs-lisp
(use-package org-roam
:hook
(after-init . org-roam-mode)
:straight (:host github :repo "jethrokuan/org-roam")
:custom
(org-roam-directory "/path/to/org-files/")
:bind (:map org-roam-mode-map
@ -51,9 +58,9 @@ The recommended method is using use-package and straight, or a similar package m
(("C-c n i" . org-roam-insert))))
```
For more detailed installation instructions (including instructions for
Spacemacs users), please see [the installation
documentation](https://org-roam.readthedocs.io/en/develop/installation/).
For more detailed installation and configuration instructions (including for
Doom and Spacemacs users), please see [the
documentation](https://org-roam.readthedocs.io/en/master/installation/).
## Knowledge Bases using Org-roam