From a563506861c223c2ce0e86464e9f5500c8662df2 Mon Sep 17 00:00:00 2001 From: Jonathan Wren Date: Sat, 25 Apr 2020 13:06:44 -0700 Subject: [PATCH] clean up readme file a bit --- README.md | 74 ++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 46 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 1a6b9824b..ab3e72437 100644 --- a/README.md +++ b/README.md @@ -1,56 +1,74 @@ jrnl [![Build Status](https://travis-ci.com/jrnl-org/jrnl.svg?branch=master)](https://travis-ci.com/jrnl-org/jrnl) [![Downloads](https://pepy.tech/badge/jrnl)](https://pepy.tech/project/jrnl) [![Version](http://img.shields.io/pypi/v/jrnl.svg?style=flat)](https://pypi.python.org/pypi/jrnl/) ==== -_To get help, [submit an issue](https://github.com/jrnl-org/jrnl/issues/new) on Github._ +_To get help, [submit an issue](https://github.com/jrnl-org/jrnl/issues/new) on +Github._ -*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* 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. -Optionally, your journal can be encrypted using the [256-bit AES](http://en.wikipedia.org/wiki/Advanced_Encryption_Standard). +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 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. +Journals aren't just for 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, or 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. In a Nutshell ------------- -to make a new entry, just type +To make a new entry, just type - jrnl yesterday: Called in sick. Used the time to clean the house and spent 4h on writing my book. + jrnl yesterday: Called in sick. Used the time cleaning the house and writing my book. -and hit return. `yesterday:` will be interpreted as a timestamp. Everything until the first sentence mark (`.?!`) will be interpreted as the title, the rest as the body. In your journal file, the result will look like this: +and hit return. `yesterday:` will be interpreted as a timestamp. Everything +until the first sentence mark (`.?!`) will be interpreted as the title, the +rest as the body. In your journal file, the result will look like this: - 2012-03-29 09:00 Called in sick. - Used the time to clean the house and spent 4h on writing my book. + [2012-03-29 09:00] Called in sick. + Used the time cleaning the house and writing my book. -If you just call `jrnl`, you will be prompted to compose your entry - but you can also configure _jrnl_ to use your external editor. +If you just call `jrnl`, you will be prompted to compose your entry - but you +can also configure _jrnl_ to use your external editor. -Known Issues ------------- -jrnl used to support integration with Day One, but no longer supports it since Day One 2 was released with a different backend. [See the GitHub issue for more information](https://github.com/jrnl-org/jrnl/issues/409). +For more information, please read our [documentation](https://jrnl.sh/overview/). -Authors -------- -Current maintainers: +## Contributors +### Maintainers +Our maintainers help keep the lights on for the project. Please thank them if +you like jrnl. * Jonathan Wren ([wren](https://github.com/wren)) * Micah Ellison ([micahellison](https://github.com/micahellison)) -Original maintainer: - - * Manuel Ebert ([maebert](https://github.com/maebert)) - -## Contributors - ### Code Contributors +This project is made with love by the many fabulous people who have +contributed. Jrnl couldn't exist without each and every one of you! + + -This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)]. - +If you'd also like to help make jrnl better, please see our [contributing +documentation](CONTRIBUTING.md). -### Financial Contributors +### Financial Backers -Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/jrnl/contribute)] +Another way show support is through direct financial contributions. These funds +go to covering our costs, and are a quick way to show your appreciation for +jrnl. -#### Individuals +[Become a financial contributor](https://opencollective.com/jrnl/contribute) +and help us sustain our community. - +