fz0x1/jrnl
1
0
Fork 0
mirror of https://github.com/jrnl-org/jrnl.git synced 2025-05-20 13:08:31 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

updated README.md:

Browse source 
- corrected information about encryption
- made additions based on proposed changes to overview.md
- made other changes for clarity and grammar
This commit is contained in:
Guy B. deBros 2020-06-09 15:26:58 -04:00 • committed by Jonathan Wren
parent 7c3abb2625
commit b32c6a9349
No known key found for this signature in database
GPG key ID: 43D5FF8722E7F68A
1 changed files with 34 additions and 34 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

68
README.md
View file

@ -4,68 +4,68 @@ jrnl [![Build Status](https://travis-ci.com/jrnl-org/jrnl.svg?branch=release)](h
_To get help, [submit an issue](https://github.com/jrnl-org/jrnl/issues/new/choose) on _To get help, [submit an issue](https://github.com/jrnl-org/jrnl/issues/new/choose) on
Github._ Github._
*jrnl* is a simple journal application for your command line. Journals are `jrnl` is a simple journal application for the command line.
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 Its goal is to facilitate the rapid creation and viewing of journal entries. It
AES](http://en.wikipedia.org/wiki/Advanced_Encryption_Standard). is flexible enough to support different use cases and organization strategies.
It is powerful enough to search through thousands of entries and display, or
"filter," only the entries you want to see.
### Why keep a journal? `jrnl` includes support for [128-bit AES
encryption](http://en.wikipedia.org/wiki/Advanced_Encryption_Standard) using
[cryptography.Fernet](https://cryptography.io/en/latest/fernet/).
Journals aren't just for people who have too much time on their summer ## In a Nutshell
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 enter
-------------
To make a new entry, just type ``` sh
jrnl yesterday: Called in sick. Used the time to clean the house and write my
book.
```
jrnl yesterday: Called in sick. Used the time cleaning the house and writing my book. `yesterday:` is interpreted by `jrnl` as a timestamp. Everything until the
first sentence ending (either `.`, `?`, or `!`) is interpreted as the title, and
and hit return. `yesterday:` will be interpreted as a timestamp. Everything the rest as the body. In your journal file, the result will look like this:
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. [2012-03-29 09:00] Called in sick.
Used the time cleaning the house and writing my book. Used the time to clean the house and write my book.
If you just call `jrnl`, you will be prompted to compose your entry - but you Entering `jrnl` without any arguments launches an external editor where you can
can also configure _jrnl_ to use your external editor. write your entry. `jrnl` will generate a time stamp for the entry after you save
and close the editor window.
For more information, please read our [documentation](https://jrnl.sh/overview/). For more information, please read the
[documentation](https://jrnl.sh/overview/).
## Contributors ## Contributors
### Maintainers ### Maintainers
Our maintainers help keep the lights on for the project. Please thank them if
you like jrnl. Our maintainers help keep the lights on for the project:
* Jonathan Wren ([wren](https://github.com/wren)) * Jonathan Wren ([wren](https://github.com/wren))
* Micah Ellison ([micahellison](https://github.com/micahellison)) * Micah Ellison ([micahellison](https://github.com/micahellison))
Please thank them if you like `jrnl`!
### Code 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 is made with love by the many fabulous people who have contributed.
`jrnl` couldn't exist without each and every one of you!
<a href="https://github.com/jrnl-org/jrnl/graphs/contributors"><img <a href="https://github.com/jrnl-org/jrnl/graphs/contributors"><img
src="https://opencollective.com/jrnl/contributors.svg?width=890&button=false" src="https://opencollective.com/jrnl/contributors.svg?width=890&button=false"
/></a> /></a>
If you'd also like to help make jrnl better, please see our [contributing If you'd also like to help make `jrnl` better, please see our [contributing
documentation](CONTRIBUTING.md). documentation](CONTRIBUTING.md).
### Financial Backers ## Financial Backers
Another way show support is through direct financial contributions. These funds 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 go to covering our costs, and are a quick way to show your appreciation for
jrnl. `jrnl`.
[Become a financial contributor](https://opencollective.com/jrnl/contribute) [Become a financial contributor](https://opencollective.com/jrnl/contribute)
and help us sustain our community. and help us sustain our community.