From 51db1ae02575f226cac9d9f446ec8f1c8092bc59 Mon Sep 17 00:00:00 2001 From: Manuel Ebert Date: Fri, 4 May 2012 16:40:12 +0200 Subject: [PATCH] Updated Readme from master --- CHANGELOG.md | 7 +++++++ README.md | 17 ++++++++++++++--- index.html | 31 ++++++++++++++++++++++++++++--- 3 files changed, 49 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2233df16..e4c81da0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,13 @@ Changelog ========= +### 0.2.3 + +* Adds a `-short` option that will only display the titles of entries (or, when filtering by tags, the context of the tag) +* Adds tag export +* Adds coloured highlight of tags (by default, highlights all tags - when filtering by tags, only highlights search tags) +* `.jrnl_config` will get automatically updated when updating jrnl to a new version + ### 0.2.2 * Adds --encrypt and --decrypt to encrypt / descrypt existing journal files diff --git a/README.md b/README.md index c50d19d2..6f591f82 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,9 @@ will list you the ten latest entries, jrnl -from "last year" -to march -everything that happened from the start of last year to the start of last march. +everything that happened from the start of last year to the start of last march. If you only want to see the titles of your entries, use + + jrnl -short ### Using Tags: @@ -107,16 +109,17 @@ It's just a regular `json` file: default_hour: 9, default_minute: 0, timeformat: "%Y-%m-%d %H:%M", + highlight: true } - `journal`: path to your journal file - `editor`: if set, executes this command to launch an external editor for writing your entries, e.g. `vim` or `subl -w` (note the `-w` flag to make sure _jrnl_ waits for Sublime Text to close the file before writing into the journal). - - `encrypt`: if true, encrypts your journal using AES. + - `encrypt`: if `true`, encrypts your journal using AES. - `password`: you may store the password you used to encrypt your journal in plaintext here. This is useful if your journal file lives in an unsecure space (ie. your Dropbox), but the config file itself is more or less safe. - `tagsymbols`: Symbols to be interpreted as tags. (__See note below__) - `default_hour` and `default_minute`: if you supply a date, such as `last thursday`, but no specific time, the entry will be created at this time - `timeformat`: how to format the timestamps in your journal, see the [python docs](http://docs.python.org/library/time.html#time.strftime) for reference - +- `highlight`: if `true` and you have [clint](http://www.nicosphere.net/clint-command-line-library-for-python/) installed, tags will be highlighted in cyan. > __Note on `tagsymbols`:__ Although it seems intuitive to use the `#` character for tags, there's a drawback: on most shells, this is interpreted as a meta-character starting a comment. This means that if you type > @@ -136,6 +139,14 @@ Can do: Why not create a beautiful [timeline](http://timeline.verite.co/) of your journal? +### Tag export + +With + + jrnl --tags + +you'll get a list of all tags you used in your journal, sorted by most frequent. Tags occuring several times in the same entry are only counted as one. + ### Markdown export jrnl --markdown diff --git a/index.html b/index.html index c59e1065..e326648d 100644 --- a/index.html +++ b/index.html @@ -100,7 +100,10 @@ Used the time to clean the house and spent 4h on writing my book. 
jrnl -from "last year" -to march
-

everything that happened from the start of last year to the start of last march.

+

everything that happened from the start of last year to the start of last march. If you only want to see the titles of your entries, use

+ +
jrnl -short
+

Using Tags:

@@ -179,17 +182,21 @@ python setup.py install default_hour: 9, default_minute: 0, timeformat: "%Y-%m-%d %H:%M", + highlight: true }
@@ -215,6 +222,15 @@ python setup.py install

Why not create a beautiful timeline of your journal?

+

Tag export

+ +

With

+ +
jrnl --tags
+
+ +

you'll get a list of all tags you used in your journal, sorted by most frequent. Tags occuring several times in the same entry are only counted as one.

+

Markdown export

jrnl --markdown
@@ -247,6 +263,15 @@ with open("my_journal.txt") as f:

Changelog

+

0.2.3

+ + +

0.2.2