From 46b67dccc36c991f60a550fe0480628850e5e389 Mon Sep 17 00:00:00 2001 From: Manuel Ebert Date: Thu, 24 May 2012 18:27:19 +0200 Subject: [PATCH] Updated Readme from master --- CHANGELOG.md | 58 ++++++++++++++++-------------- README.md | 17 ++++----- index.html | 84 +++++++++++++++++++++++-------------------- js/jrnl.js | 5 +-- templates/header.html | 2 +- 5 files changed, 86 insertions(+), 80 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d8ae2a64..50cc929b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,47 +1,53 @@ Changelog ========= -### 0.2.4 +### 0.3.0 (May 24, 2012) -* Fixes parsing of new lines in journal files and entries -* Adds support for encrypting and decrypting into new files +* [Fixed] Dates such as "May 3" will now be interpreted as being in the past if the current day is at least 28 days in the future +* [Fixed] Bug where composed entry is lost when the journal file fails to load +* Changed directory structure and install scripts (removing the necessity to make an alias from `jrnl` to `jrnl.py`) -### 0.2.3 +#### 0.2.4 (May 21, 2012) -* 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 +* [Fixed] Parsing of new lines in journal files and entries +* [Improved] Adds support for encrypting and decrypting into new files -### 0.2.2 +#### 0.2.3 (May 3, 2012) -* Adds --encrypt and --decrypt to encrypt / descrypt existing journal files -* Adds markdown export (kudos to dedan) +* [Improved] Adds a `-short` option that will only display the titles of entries (or, when filtering by tags, the context of the tag) +* [Improved] Adds tag export +* [Improved] Adds coloured highlight of tags (by default, highlights all tags - when filtering by tags, only highlights search tags) +* [Improved] `.jrnl_config` will get automatically updated when updating jrnl to a new version -### 0.2.1 +#### 0.2.2 (April 17, 2012) -* Submitted to [PyPi](http://pypi.python.org/pypi/jrnl/0.2.1). +* [Improved] Adds --encrypt and --decrypt to encrypt / decrypt existing journal files +* [Improved] Adds markdown export (kudos to dedan) -### 0.2.0 +#### 0.2.1 (April 17, 2012) -* Encrypts using CBC -* `key` has been renamed to `password` in config to avoid confusion. (The key use to encrypt and decrypt a journal is the SHA256-hash of the password.) +* [Improved] Submitted to [PyPi](http://pypi.python.org/pypi/jrnl/0.2.1). -### 0.1.1 +### 0.2.0 (April 16, 2012) -* Removed unnecessary print commands -* Created the documentation +* [Improved] Encrypts using CBC +* [Fixed] `key` has been renamed to `password` in config to avoid confusion. (The key use to encrypt and decrypt a journal is the SHA256-hash of the password.) -### 0.1.0 +#### 0.1.1 (April 15, 2012) -* Supports encrypted journals using AES encryption -* Support external editors for composing entries +* [Fixed] Removed unnecessary print commands +* [Improved] Created the documentation -### 0.0.2 +### 0.1.0 (April 13, 2012) -* Filtering by tags and dates -* Now using dedicated classes for Journals and entries +* [Improved] Supports encrypted journals using AES encryption +* [Improved] Support external editors for composing entries -### 0.0.1 +#### 0.0.2 (April 5, 2012) + +* [Improved] Filtering by tags and dates +* [Fixed] Now using dedicated classes for Journals and entries + +#### 0.0.1 (March 29, 2012) * Composing entries works. That's pretty much it. diff --git a/README.md b/README.md index 6f591f82..c1303caf 100644 --- a/README.md +++ b/README.md @@ -73,23 +73,20 @@ Timestamps that work: Installation ------------ -You can install _jrnl_ manually by cloning the repository: +Install _jrnl_ using pip: + + pip install jrnl + +Alternatively, install manually by cloning the repository: git clone git://github.com/maebert/jrnl.git cd jrnl python setup.py install -or by using pip: - - pip install jrnl - -Afterwards, you may want to create an alias in your `.bashrc` or `.bash_profile` or whatever floats your shell: - - alias jrnl="jrnl.py" - ### Known Issues -_jrnl_ relies on the `Crypto` package to encrypt journals, which has some known problems in automatically installing within virtual environments. +- The Windows shell prior to Windows 7 has issues with unicode encoding. If you want to use non-ascii characters, change the codepage with `chcp 1252` before using `jrnl` (Thanks to Yves Pouplard for solving this!) +- _jrnl_ relies on the `Crypto` package to encrypt journals, which has some known problems with installing within virtual environments. Advanced usage -------------- diff --git a/index.html b/index.html index f4faca4b..1de6f310 100644 --- a/index.html +++ b/index.html @@ -52,7 +52,7 @@
- +