mirror of
https://github.com/jrnl-org/jrnl.git
synced 2025-05-10 16:48:31 +02:00
Updated Readme from master
This commit is contained in:
parent
0383237511
commit
6f9bc3a8cd
3 changed files with 57 additions and 4 deletions
|
@ -1,6 +1,14 @@
|
||||||
Changelog
|
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
|
### 0.2.0
|
||||||
|
|
||||||
* Encrypts using CBC
|
* Encrypts using CBC
|
||||||
|
@ -10,7 +18,6 @@ Changelog
|
||||||
|
|
||||||
* Removed unnecessary print commands
|
* Removed unnecessary print commands
|
||||||
* Created the documentation
|
* Created the documentation
|
||||||
* Registered jrnl in the python package repository
|
|
||||||
|
|
||||||
### 0.1.0
|
### 0.1.0
|
||||||
|
|
||||||
|
|
18
README.md
18
README.md
|
@ -132,12 +132,28 @@ It's just a regular `json` file:
|
||||||
|
|
||||||
Can do:
|
Can do:
|
||||||
|
|
||||||
jrnl -json
|
jrnl --json
|
||||||
|
|
||||||
Why not create a beautiful [timeline](http://timeline.verite.co/) of your journal?
|
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
|
### 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
|
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
|
import hashlib, Crypto.Cipher
|
||||||
|
|
34
index.html
34
index.html
|
@ -210,13 +210,32 @@ python setup.py install
|
||||||
|
|
||||||
<p>Can do:</p>
|
<p>Can do:</p>
|
||||||
|
|
||||||
<pre><code>jrnl -json
|
<pre><code>jrnl --json
|
||||||
</code></pre>
|
</code></pre>
|
||||||
|
|
||||||
<p>Why not create a beautiful <a href="http://timeline.verite.co/">timeline</a> of your journal?</p>
|
<p>Why not create a beautiful <a href="http://timeline.verite.co/">timeline</a> of your journal?</p>
|
||||||
|
|
||||||
|
<h3>Markdown export</h3>
|
||||||
|
|
||||||
|
<pre><code>jrnl --markdown
|
||||||
|
</code></pre>
|
||||||
|
|
||||||
|
<p>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.</p>
|
||||||
|
|
||||||
<h3>Encryption</h3>
|
<h3>Encryption</h3>
|
||||||
|
|
||||||
|
<p>You can encrypt your existing journal file or change its password using</p>
|
||||||
|
|
||||||
|
<pre><code>jrnl --encrypt
|
||||||
|
</code></pre>
|
||||||
|
|
||||||
|
<p>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,</p>
|
||||||
|
|
||||||
|
<pre><code>jrnl --decrypt
|
||||||
|
</code></pre>
|
||||||
|
|
||||||
|
<p>will replace your encrypted journal file by a Journal in plain text.</p>
|
||||||
|
|
||||||
<p>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</p>
|
<p>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</p>
|
||||||
|
|
||||||
<pre><code>import hashlib, Crypto.Cipher
|
<pre><code>import hashlib, Crypto.Cipher
|
||||||
|
@ -228,6 +247,18 @@ with open("my_journal.txt") as f:
|
||||||
</code></pre>
|
</code></pre>
|
||||||
<h1>Changelog</h1>
|
<h1>Changelog</h1>
|
||||||
|
|
||||||
|
<h3>0.2.2</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>Adds --encrypt and --decrypt to encrypt / descrypt existing journal files</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>0.2.1</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>Submitted to <a href="http://pypi.python.org/pypi/jrnl/0.2.1">PyPi</a>.</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
<h3>0.2.0</h3>
|
<h3>0.2.0</h3>
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
|
@ -240,7 +271,6 @@ with open("my_journal.txt") as f:
|
||||||
<ul>
|
<ul>
|
||||||
<li>Removed unnecessary print commands</li>
|
<li>Removed unnecessary print commands</li>
|
||||||
<li>Created the documentation</li>
|
<li>Created the documentation</li>
|
||||||
<li>Registered jrnl in the python package repository</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h3>0.1.0</h3>
|
<h3>0.1.0</h3>
|
||||||
|
|
Loading…
Add table
Reference in a new issue