diff --git a/CHANGELOG.md b/CHANGELOG.md index 84dbfc10..c4b5c160 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,14 @@ Changelog ========= +### 0.2.2 + +* Adds --encrypt and --decrypt to encrypt / descrypt existing journal files + +### 0.2.1 + +* Submitted to [PyPi](http://pypi.python.org/pypi/jrnl/0.2.1). + ### 0.2.0 * Encrypts using CBC @@ -10,7 +18,6 @@ Changelog * Removed unnecessary print commands * Created the documentation -* Registered jrnl in the python package repository ### 0.1.0 diff --git a/README.md b/README.md index 6afe2f45..c50d19d2 100644 --- a/README.md +++ b/README.md @@ -132,12 +132,28 @@ It's just a regular `json` file: Can do: - jrnl -json + jrnl --json Why not create a beautiful [timeline](http://timeline.verite.co/) of your journal? +### Markdown export + + jrnl --markdown + +Markdown is a simple markup language that is human readable and can be used to be rendered to other formats (html, pdf). This README for example is formatted in markdown and github makes it look nice. + ### Encryption +You can encrypt your existing journal file or change its password using + + jrnl --encrypt + +If it is already encrypted, you will first be asked for the current password. You can then enter a new password and your plain journal will replaced by the encrypted file. Conversely, + + jrnl --decrypt + +will replace your encrypted journal file by a Journal in plain text. + Should you ever want to decrypt your journal manually, you can do so with any program that supports the AES algorithm. The key used for encryption is the SHA-256-hash of your password, and the IV (initialisation vector) is stored in the first 16 bytes of the encrypted file. So, to decrypt a journal file in python, run import hashlib, Crypto.Cipher diff --git a/index.html b/index.html index 6e23566b..805b7a03 100644 --- a/index.html +++ b/index.html @@ -210,13 +210,32 @@ python setup.py install
Can do:
-jrnl -json
+jrnl --json
Why not create a beautiful timeline of your journal?
+Markdown export
+
+jrnl --markdown
+
+
+Markdown is a simple markup language that is human readable and can be used to be rendered to other formats (html, pdf). This README for example is formatted in markdown and github makes it look nice.
+
Encryption
+You can encrypt your existing journal file or change its password using
+
+jrnl --encrypt
+
+
+If it is already encrypted, you will first be asked for the current password. You can then enter a new password and your plain journal will replaced by the encrypted file. Conversely,
+
+jrnl --decrypt
+
+
+will replace your encrypted journal file by a Journal in plain text.
+
Should you ever want to decrypt your journal manually, you can do so with any program that supports the AES algorithm. The key used for encryption is the SHA-256-hash of your password, and the IV (initialisation vector) is stored in the first 16 bytes of the encrypted file. So, to decrypt a journal file in python, run
import hashlib, Crypto.Cipher
@@ -228,6 +247,18 @@ with open("my_journal.txt") as f:
Changelog
+0.2.2
+
+
+- Adds --encrypt and --decrypt to encrypt / descrypt existing journal files
+
+
+0.2.1
+
+
+- Submitted to PyPi.
+
+
0.2.0
@@ -240,7 +271,6 @@ with open("my_journal.txt") as f:
- Removed unnecessary print commands
- Created the documentation
-- Registered jrnl in the python package repository
0.1.0