From 9787ce7979ac8b862370e4922684b88094883b03 Mon Sep 17 00:00:00 2001
From: Jordan Petridis <jordanpetridis@protonmail.com>
Date: Fri, 3 Nov 2017 15:33:21 +0200
Subject: [PATCH] Added an overview to README.md .

---
 README.md | 34 ++++++++++++++++++++++++++--------
 1 file changed, 26 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 3cd1274..f08ad7b 100644
--- a/README.md
+++ b/README.md
@@ -2,15 +2,11 @@
 ## Multithreaded, safe, and reliable Gtk+ Podcast client.
 This is a prototype of a podcast client written in Rust.
 
+[![pipeline status](https://gitlab.gnome.org/alatiera/Hammond/badges/master/pipeline.svg)](https://gitlab.gnome.org/alatiera/Hammond/commits/master)
+
 ![podcasts_view](./assets/podcasts_view.png)
 ![podcast_widget](./assets/podcast_widget.png)
 
-**A note about the project's name:**
-
-The project was named after Allan Moore's character [Evey Hammond](https://en.wikipedia.org/wiki/Evey_Hammond) from the graphic novel V for Vendetta.
-
-It has nothing to do with the horrible headlines on the news.
-
 ## Quick start
 ```sh
 git clone https://gitlab.gnome.org/alatiera/hammond.git
@@ -49,9 +45,31 @@ cargo build --all
 
 ## Overview:
 
-To be added.
+```sh
+$ tree -d
+├── assets              # png's used in the README.md
+├── hammond-data        # Storate related stuff, Sqlite db, XDG setup.
+│   ├── migrations      # Diesel migrations.
+│   │   └── ... 
+│   ├── src
+│   └── tests
+│       └── feeds       # Raw RSS Feeds used for tests.
+├── hammond-downloader  # Really basic, Really crappy downloader.
+│   └── src
+├── hammond-gtk         # The Gtk+ client.
+│   ├── gtk             # Contains the glade.ui files and.
+│   └── src
+│       ├── views       # Currently only contains the Podcasts_view.
+│       └── widgets     # Contains custom widgets such as Podcast and Episode.
+```
 
 ## Contributing:
 There alot of thins to be done, take a look at TODO.md or grep for TODO: and FIXME:.
 
-to be added: CONTRIBUTING.md
\ No newline at end of file
+to be added: CONTRIBUTING.md
+
+## A note about the project's name:
+
+The project was named after Allan Moore's character [Evey Hammond](https://en.wikipedia.org/wiki/Evey_Hammond) from the graphic novel V for Vendetta.
+
+It has nothing to do with the horrible headlines on the news.