diff --git a/CHANGELOG.md b/CHANGELOG.md index bf107529..5af62474 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -14,6 +14,16 @@ The following log documents the history of the server project. None +### 0.4.0 - 2020-01-08 + +#### Added + +- A web-based digest (#380) + +#### Fixed + +- Send inactive reminders with a correct email type (#385) + ### 0.3.4 - 2019-12-24 #### Added diff --git a/README.md b/README.md index 4f115c65..4eee89b6 100644 --- a/README.md +++ b/README.md @@ -1,56 +1,40 @@ ![Dnote](assets/logo.png) ========================= -Dnote is a simple personal knowledge base. - [![Build Status](https://travis-ci.org/dnote/dnote.svg?branch=master)](https://travis-ci.org/dnote/dnote) -## What is Dnote? +[Dnote](https://www.getdnote.com) is a lightweight personal knowledge base. 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, browser extension, web client, or an IDE plugin. -Dnote is a lightweight personal knowledge base. 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, browser extension, web client, or an IDE plugin. +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 also offers a seamless **multi device sync**, and **automated spaced repetition** to retain your memory. +![Dnote web application running on various devices](assets/devices.png "Dnote web application running on various devices") -For more details, see the [download page](https://www.getdnote.com/download) and [features](https://www.getdnote.com/pricing). +## Get Started -![A demo of Dnote CLI](assets/cli.gif) +The quickest way to try Dnote is to use the hosted version at https://app.getdnote.com -## Quick install +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). -The quickest way to try Dnote is to install the command line interface. +## Dnote clients -### Install with Homebrew +You can use the following client programs to interact with Dnote: -On macOS, you can install using Homebrew: +* [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 -```sh -brew tap dnote/dnote -brew install dnote +For the installation guide, please see the [download page](https://www.getdnote.com/download). -# to upgrade to the latest version -brew upgrade dnote -``` +## What is a personal knowledge base? -### Install with script - -You can use the installation script to install the latest version: - - curl -s https://raw.githubusercontent.com/dnote/dnote/master/pkg/cli/install.sh | sh - -In some cases, you might need an elevated permission: - - curl -s https://raw.githubusercontent.com/dnote/dnote/master/pkg/cli/install.sh | sudo sh - -### Install with tarball - -You can download the binary for your platform manually from the [releases page](https://github.com/dnote/dnote/releases). - -## 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. -* Your data is stored locally first and in a SQLite format which is [suitable for continued accessibility](https://www.sqlite.org/locrsf.html). +* [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. diff --git a/assets/devices.png b/assets/devices.png new file mode 100644 index 00000000..5d40ee10 Binary files /dev/null and b/assets/devices.png differ diff --git a/host/docker/README.md b/host/docker/README.md index 85ec1264..864ce8c3 100644 --- a/host/docker/README.md +++ b/host/docker/README.md @@ -4,13 +4,9 @@ The official Dnote docker image. ## Installing Dnote Server Using Docker -*Installing Dnote through Docker is currently in beta.* For the an alternative installation guide, please see [the installation guide](https://github.com/dnote/dnote/blob/master/SELF_HOSTING.md). - -### Steps - 1. Install [Docker](https://docs.docker.com/install/). 2. Install Docker [Compose](https://docs.docker.com/compose/install/). -3. Download the [docker-compose.yml](https://raw.githubusercontent.com/dnote/dnote/master/host/docker/docker-compose.yml) file. +3. Download the [docker-compose.yml](https://raw.githubusercontent.com/dnote/dnote/master/host/docker/docker-compose.yml) file by running: ``` curl https://raw.githubusercontent.com/dnote/dnote/master/host/docker/docker-compose.yml > docker-compose.yml @@ -25,4 +21,4 @@ docker-compose up -d Visit http://localhost:3000 in your browser to see Dnote running. -please see [the installation guide](https://github.com/dnote/dnote/blob/master/SELF_HOST.md) for further configuration. +Please see [the installation guide](https://github.com/dnote/dnote/blob/master/SELF_HOSTING.md) for further configuration.