mirror of
https://github.com/jrnl-org/jrnl.git
synced 2025-05-10 08:38:32 +02:00
5b029e6117
* Applying doc changes based on reviews of past several documentation PRs
* Update docs
Clean up encryption docs
Clean up security docs
Delete export.md
Make new formats.md and add to sidebar. Also add all of the built-in formats, and examples for each.
Update mkdocs config for new files
* Fix broken docs links
* Correct incomplete sentences and markdown formatting issues
* Make overview a little more concise
* Update some command line arguments to latest version and make it a bit more concise
* Clean up unneeded TOML modifications and other scaffolding not needed for 3.9
* Revert "Clean up unneeded TOML modifications and other scaffolding not needed for 3.9"
This reverts commit 13b4266ed1.
* Specify that brew is also the easiest way to install jrnl on Linux
* Update docs/security.md
* Update docs/recipes.md
* Doc updates:
- Remove import/export page, fold it into formats
- Rename security to privacy-and-security.md to avoid conflation w/ github security issues
- Various small cleanup and edits from PR review
Co-authored-by: Jonathan Wren <jonathan@nowandwren.com>
68 lines
2.4 KiB
Markdown
68 lines
2.4 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.
|
|
|
|
You can use it to easily create, search, and view journal entries. Journals are
|
|
stored as human-readable plain text, and can also be encrypted using [AES
|
|
encryption](http://en.wikipedia.org/wiki/Advanced_Encryption_Standard).
|
|
|
|
## 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.
|
|
|
|
If you just call `jrnl`, you will be prompted to compose your entry - but you
|
|
can also configure _jrnl_ to use your external editor.
|
|
|
|
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>
|