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

More changes to overview.md:

Browse source 
- fixed up the headings
- added information about multi-platform support

This is a work in progress and _not_ ready for prime-time.
- need to add to Command-Line Interface section, among other things
This commit is contained in:
Guy B. deBros 2020-06-04 17:47:14 -04:00
parent ed7712a073
commit 05b507741b
1 changed files with 22 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
docs/overview.md
View file

@ -3,39 +3,41 @@
`jrnl` is a simple but powerful plain text journal application for the command `jrnl` is a simple but powerful plain text journal application for the command
line. line.
Your imagination may be limitless, but your memory probably isn't. `jrnl` lets ## Features
you write something down, and then it gets out of the way.
## how it works ### Command-Line Interface
New entries are created on the command line: Everything happens on the command line.
``` sh ### Text-Based
jrnl today at 8am: I arrived at work to find a birthday present on my desk. My colleagues are the best!
```
Support for external editors is included.
### one file type to rule them all...
`jrnl` stores your journals as human-readable, future-proof plain text files. `jrnl` stores your journals as human-readable, future-proof plain text files.
You can store them wherever you want, including in shared folders to keep them You can store them wherever you want, including in shared folders to keep them
synchronized between devices. And because journal files are stored as plain synchronized between devices. And because journal files are stored as plain
text, you can rest assured that your journals will be readable for centuries. text, you can rest assured that your journals will be readable for centuries.
### ...and as many files as you need ### Support for Multiple Journals
`jrnl` allows you to work with multiple journals, each of which is stored as a `jrnl` allows you to work with multiple journals, each of which is stored as a
single file using date and time tags to identify individual entries. `jrnl` single file using date and time tags to identify individual entries. `jrnl`
makes it easy to find the entries you want, and only the ones you want, so that makes it easy to find the entries you want, and only the ones you want, so that
you can read them or edit them. Here's an example: say you want to find all of you can read them or edit them.
the entries you wrote on January 3rd, 2020 that include the word _cat_, and
change every instance of the word _cat_ to _dog_? Easy:
``` sh ### Support for External Editors
jrnl -on 2020-01-03 -contains 'cat' --edit
```
### for your eyes only `jrnl` allows you to search for specific entries and edit them in your favorite
text editor.
To protect your journal, you can encrypt it using [256-bit AES encryption](http://en.wikipedia.org/wiki/Advanced_Encryption_Standard). ### Encryption
`jrnl` includes support for [256-bit AES
encryption](http://en.wikipedia.org/wiki/Advanced_Encryption_Standard) using
[cryptography.io](https://cryptography.io).
### Multi-Platform Support
`jrnl` is compatible with most operating systems. Pre-compiled binaries are available through several distribution channels, and you can build from source. See the installation page for more information.
### Open-Source
`jrnl` is written in [Python](https://www.python.org) and maintained by a [friendly community](https://github.com/jrnl-org/jrnl) of open-source software enthusiasts.