mirror of
https://github.com/jrnl-org/jrnl.git
synced 2025-05-10 16:48:31 +02:00
ec12e174cd
* updated README.md: - corrected information about encryption - made additions based on proposed changes to overview.md - made other changes for clarity and grammar * ongoing changes to overview.md * added note that `pycrypto` is required made other small changes for grammar and clarity * added new python decryption script to encryption.md * updated encryption.md to clarify dependencies other relatively small changes for clarity straightened quotes Co-authored-by: Guy B. deBros <guydebros@users.noreply.github.com>
74 lines
2.7 KiB
Markdown
74 lines
2.7 KiB
Markdown
jrnl [](https://travis-ci.com/jrnl-org/jrnl) [](https://pepy.tech/project/jrnl) [](https://pypi.python.org/pypi/jrnl/)
|
|
====
|
|
|
|
_To get help, [submit an issue](https://github.com/jrnl-org/jrnl/issues/new/choose) on
|
|
Github._
|
|
|
|
`jrnl` is a simple journal application for the command line.
|
|
|
|
Its goal is to facilitate the rapid creation and viewing of journal entries. It
|
|
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.
|
|
|
|
`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/).
|
|
|
|
## In a Nutshell
|
|
|
|
To make a new entry, just enter
|
|
|
|
``` sh
|
|
jrnl yesterday: Called in sick. Used the time to clean the house and write my
|
|
book.
|
|
```
|
|
|
|
`yesterday:` is interpreted by `jrnl` as a timestamp. Everything until the
|
|
first sentence ending (either `.`, `?`, or `!`) is interpreted as the title, and
|
|
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 write my book.
|
|
|
|
Entering `jrnl` without any arguments launches an external editor where you can
|
|
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 the
|
|
[documentation](https://jrnl.sh/overview/).
|
|
|
|
## Contributors
|
|
|
|
### Maintainers
|
|
|
|
Our maintainers help keep the lights on for the project:
|
|
|
|
* Jonathan Wren ([wren](https://github.com/wren))
|
|
* Micah Ellison ([micahellison](https://github.com/micahellison))
|
|
|
|
Please thank them if you like `jrnl`!
|
|
|
|
### 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!
|
|
|
|
<a href="https://github.com/jrnl-org/jrnl/graphs/contributors"><img
|
|
src="https://opencollective.com/jrnl/contributors.svg?width=890&button=false"
|
|
/></a>
|
|
|
|
If you'd also like to help make `jrnl` better, please see our [contributing
|
|
documentation](CONTRIBUTING.md).
|
|
|
|
## Financial Backers
|
|
|
|
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`.
|
|
|
|
[Become a financial contributor](https://opencollective.com/jrnl/contribute)
|
|
and help us sustain our community.
|
|
|
|
<a href="https://opencollective.com/jrnl"><img
|
|
src="https://opencollective.com/jrnl/individuals.svg?width=890"></a>
|