From ed7712a073ad2740576690881d73f488f2d939b0 Mon Sep 17 00:00:00 2001 From: "Guy B. deBros" Date: Tue, 19 May 2020 15:39:26 -0400 Subject: [PATCH] More changes to overview.md in response to feedback "why keep a journal" section removed -- it could be re-added as its own page, but it's not front-page material --- docs/overview.md | 65 +++++++++++++++++++++++------------------------- 1 file changed, 31 insertions(+), 34 deletions(-) diff --git a/docs/overview.md b/docs/overview.md index 7e898da0..d275e068 100644 --- a/docs/overview.md +++ b/docs/overview.md @@ -1,44 +1,41 @@ # Overview -## What is `jrnl`? - `jrnl` is a simple but powerful plain text journal application for the command line. -`jrnl` is not the only plain text journal application. It includes features that -are common to many other applications: +Your imagination may be limitless, but your memory probably isn't. `jrnl` lets +you write something down, and then it gets out of the way. -- Journal entries are created and displayed directly from the command line. -- Journals are stored as human-readable, future-proof plain text files. Because - files are stored as plain text, you can rest assured that your journals will - still be readable in 2050 and beyond. Entries can be searched, filtered, and - edited rapidly and easily. -- Journals can be stored anywhere, including in shared folders so that they can - be synchronized between devices. -- Journal entries can be created and modified using an external editor of your - choice, using the command line as a starting point to filter specific entries. -- BeJournals are stored in single files using date/time tags to identify - individual entries. Some systems endorse a file/folder methodology; `jrnl` - keeps -- Journals can be protected using [256-bit - AES encryption](http://en.wikipedia.org/wiki/Advanced_Encryption_Standard). +## how it works -## Why keep a journal? +New entries are created on the command line: -Journals aren't just for people who have too much time on their summer vacation. -Journals help you keep track of events, thoughts, feelings, tasks, ideas, and -anything else that is worth remembering. Your imagination may be limitless, but -your memory probably isn't. +``` sh +jrnl today at 8am: I arrived at work to find a birthday present on my desk. My colleagues are the best! +``` -To begin, try to write at least 20 words a day. `jrnl` makes this incredibly -easy. Fire up a terminal and type, `jrnl today at 8am: I arrived at work to find -a birthday present on my desk. My colleagues are the best!` You can reflect on -what made your day special so that you'll always remember why you haven't wasted -it. Or try using `jrnl` to keep a gratitude journal, a habit that has been shown -to improve mental health and quality of life. +Support for external editors is included. -For professional use, a text-based journal can be the perfect complement to your -to-do list -- a record of what you've done as well as how and when you've done -it. You can use a journal as a quick way to keep a change log (`jrnl Updated -jrnl overview page to make it more awesomer`). Or use it to keep a lab notebook. -The possibilities are almost endless. +### one file type to rule them all... + +`jrnl` stores your journals as human-readable, future-proof plain text files. +You can store them wherever you want, including in shared folders to keep them +synchronized between devices. And because journal files are stored as plain +text, you can rest assured that your journals will be readable for centuries. + +### ...and as many files as you need + +`jrnl` allows you to work with multiple journals, each of which is stored as a +single file using date and time tags to identify individual entries. `jrnl` +makes it easy to find the entries you want, and only the ones you want, so that +you can read them or edit them. Here's an example: say you want to find all of +the entries you wrote on January 3rd, 2020 that include the word _cat_, and +change every instance of the word _cat_ to _dog_? Easy: + +``` sh +jrnl -on 2020-01-03 -contains 'cat' --edit +``` + +### for your eyes only + +To protect your journal, you can encrypt it using [256-bit AES encryption](http://en.wikipedia.org/wiki/Advanced_Encryption_Standard). \ No newline at end of file