summaryrefslogtreecommitdiffstats
path: root/docs/overview.md
diff options
context:
space:
mode:
authorManuel Ebert <manuel@1450.me>2019-07-07 19:21:59 -0700
committerManuel Ebert <manuel@1450.me>2020-04-10 11:51:55 -0700
commitb7e077be68e61b5f8469e2c92971c58b5cb4bc59 (patch)
treeb5a44e589bfee3f6334c8f989fde4e84a5fda3cd /docs/overview.md
parent3a72313d068233e895314949444eee161225d6de (diff)
Moving from sphinx to mkdocs
Cleaning up docs Lighter side bar Landing page refresh Add JSON-LD and semantic tags
Diffstat (limited to 'docs/overview.md')
-rw-r--r--docs/overview.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/overview.md b/docs/overview.md
new file mode 100644
index 00000000..c634ae8e
--- /dev/null
+++ b/docs/overview.md
@@ -0,0 +1,31 @@
+# Overview
+
+## What is jrnl?
+
+`jrnl` is a simple journal application for
+your command line. Journals are stored as human readable plain text
+files - you can put them into a Dropbox folder for instant syncing and
+you can be assured that your journal will still be readable in 2050,
+when all your fancy iPad journal applications will long be forgotten.
+
+`jrnl` also plays nice with the fabulous
+[DayOne](http://dayoneapp.com) and can read and write directly from and
+to DayOne Journals.
+
+Optionally, your journal can be encrypted using the [256-bit
+AES](http://en.wikipedia.org/wiki/Advanced_Encryption_Standard).
+
+## Why keep a journal?
+
+Journals aren't just for angsty teenagers and people who have too much
+time on their summer vacation. A journal helps you to keep track of the
+things you get done and how you did them. Your imagination may be
+limitless, but your memory isn't.
+
+For personal use, make it a good habit to write at least 20 words a day.
+Just to reflect what made this day special, why you haven't wasted it.
+
+For professional use, consider a text-based journal to be the perfect
+complement to your GTD todo list - a documentation of what and how
+you've done it. Or use it as a quick way to keep a change log. Or use it
+to keep a lab book.