From 232c443d46a3227164d91d5d558d15ffb26d2950 Mon Sep 17 00:00:00 2001 From: Sung Won Cho Date: Tue, 28 Jan 2020 10:15:32 +1100 Subject: [PATCH] Update readme --- README.md | 45 ++++++++++++++++----------------------------- 1 file changed, 16 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index eafc20c5..1df1c8b4 100644 --- a/README.md +++ b/README.md @@ -3,49 +3,36 @@ [![Build Status](https://travis-ci.org/dnote/dnote.svg?branch=master)](https://travis-ci.org/dnote/dnote) -[Dnote](https://www.getdnote.com) is a lightweight personal knowledge base for programmers. The main design goal is to **keep you focused** by providing a way of swiftly capturing new information **without having to switch environment**. To that end, you can use Dnote as a [command-line interface](https://github.com/dnote/dnote/blob/master/pkg/cli/README.md), browser extension, web client, or an IDE plugin. +[Dnote](https://www.getdnote.com) is a simple command line notebook for programmers. -It also offers a seamless **multi-device sync**, and **automated spaced repetition** to retain your memory. For more information, please see [features](https://www.getdnote.com/pricing). +It **keeps you focused** by providing a way of swiftly capturing new information **without leaving your terminal**. It also offers a seamless **multi-device sync** and **web application**. ![A demo of Dnote command line interface](assets/cli.gif "Dnote command line interface") -## Get Started +## Installation -The quickest way to try Dnote is to use the hosted version at https://app.getdnote.com +On macOS, you can install using Homebrew: -Alternatively, you can self-host a Dnote server by either [using Docker](https://github.com/dnote/dnote/blob/master/host/docker/README.md) or [using a binary](https://github.com/dnote/dnote/blob/master/SELF_HOSTING.md). +```sh +brew tap dnote/dnote +brew install dnote -![Dnote web application running on various devices](assets/devices.png "Dnote web application running on various devices") +# to upgrade to the latest version +brew upgrade dnote +``` -## Dnote clients +On Linux or macOS, you can use the installation script: -You can use the following client programs to interact with Dnote: + curl -s https://raw.githubusercontent.com/dnote/dnote/master/pkg/cli/install.sh | sh -* [Command line interface](https://github.com/dnote/dnote/blob/master/pkg/cli/README.md) -* Chrome browser extension -* Firefox addon -* [Web interface](https://app.getdnote.com) -* Atom plugin +In some cases, you might need an elevated permission: -For the installation guide, please see the [download page](https://www.getdnote.com/download). + curl -s https://raw.githubusercontent.com/dnote/dnote/master/pkg/cli/install.sh | sudo sh -## What is a personal knowledge base? - -A personal knowledge base is a tool used to capture the knowledge of an individual and retrieve it later. - -Dnote is great for building a personal knowledge base because: - -* [It is fully open-source](https://www.getdnote.com/blog/open-sourcing-dnote). -* You own your data locally using a SQLite format which is [suitable for continued accessibility](https://www.sqlite.org/locrsf.html). -* It provides a way of instantly capturing new lessons without distracting you. -* It automates spaced repetition to help you retain your memory. - -You can read more in the following user stories: - -- [How I Built a Personal Knowledge Base for Myself](https://www.getdnote.com/blog/how-i-built-personal-knowledge-base-for-myself/) -- [I Wrote Down Everything I Learned While Programming for a Month](https://www.getdnote.com/blog/writing-everything-i-learn-coding-for-a-month/) +Otherwise, you can download the binary for your platform manually from the [releases page](https://github.com/dnote/dnote/releases). ## See Also - [Homepage](https://www.getdnote.com) - [Forum](https://forum.getdnote.com) +- [I Wrote Down Everything I Learned While Programming for a Month](https://www.getdnote.com/blog/writing-everything-i-learn-coding-for-a-month/)