From 7c5b42ec9bcb7ae19a240cc25cbb9cb71ca8b796 Mon Sep 17 00:00:00 2001
From: Manuel Ebert <manuel.ebert@upf.edu>
Date: Mon, 16 Apr 2012 14:16:31 +0200
Subject: [PATCH] Updated Readme from master

---
 README.md  | 31 ++++++++++++++++++++++++-------
 index.html | 19 +++++++++++++++++--
 2 files changed, 41 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index cf8ab8f7..09fce2a8 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,15 @@
-# jrnl
+jrnl
+====
 
 *jrnl* is a simple journal application for your command line. Journals are stored as human readable plain text files - you can put them into a Dropbox folder for instant syncinc and you can be assured that your journal will still be readable in 2050, when all your fancy iPad journal applications will long be forgotten.
 
-## Why keep a journal?
+Why keep a journal?
+-------------------
 
 Journals aren't only for 13-year old girls and people who have too much time on their summer vacation. A journal helps you to keep track of the things you get done and how you did them. Your imagination may be limitless, but your memory isn't. For personal use, make it a good habit to write at least 20 words a day. Just to reflect what made this day special, why you haven't wasted it. For professional use, consider a text-based journal to be the perfect complement to your GTD todo list - a documentation of what and how you've done it.
 
-## How to use?
+How to use?
+-----------
 
 to make a new entry, just type
 
@@ -25,7 +28,7 @@ If we start our entry by e.g. `yesterday:` or `last week monday at 9am:` the ent
 
 ### Viewing:
 
-    jrnl -10   
+    jrnl -n 10   
 
 will list you the ten latest entries,
 
@@ -68,11 +71,25 @@ Can do:
     jrnl -json
 
 
-## Installation
+Installation
+------------
 
-...
+You can install _jrnl_ manually by cloning the repository:
 
-## Advanced configuration
+    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"
+
+Advanced configuration
+----------------------
 
 The first time launched, _jrnl_ will create a file called `.jrnl_config` in your home directory. It's just a regular `json` file:
 
diff --git a/index.html b/index.html
index 4d833f0a..ddbed0e4 100644
--- a/index.html
+++ b/index.html
@@ -90,7 +90,7 @@ Used the time to clean the house and spent 4h on writing my book.
 
 <h3>Viewing:</h3>
 
-<pre><code>jrnl -10
+<pre><code>jrnl -n 10
 </code></pre>
 
 <p>will list you the ten latest entries,</p>
@@ -142,7 +142,22 @@ Used the time to clean the house and spent 4h on writing my book.
 
 <h2>Installation</h2>
 
-<p>...</p>
+<p>You can install <em>jrnl</em> manually by cloning the repository:</p>
+
+<pre><code>git clone git://github.com/maebert/jrnl.git
+cd jrnl
+python setup.py install
+</code></pre>
+
+<p>or by using pip:</p>
+
+<pre><code>pip install jrnl
+</code></pre>
+
+<p>Afterwards, you may want to create an alias in your <code>.bashrc</code> or <code>.bash_profile</code> or whatever floats your shell:</p>
+
+<pre><code>alias jrnl="jrnl.py"
+</code></pre>
 
 <h2>Advanced configuration</h2>