From 0c92738c36b4f1707352a14bfe69a3c75fd2440c Mon Sep 17 00:00:00 2001
From: Max Magorsch <max@magorsch.de>
Date: Sat, 25 Jan 2020 22:36:03 +0100
Subject: Update the documentation in the README

Signed-off-by: Max Magorsch <max@magorsch.de>
---
 README.md                          |  26 +++++++++++++++++++++++---
 docs/screenshot.png                | Bin 0 -> 89391 bytes
 docs/tyrian_sphinx_theme_label.png | Bin 0 -> 28222 bytes
 docs/tyrian_sphinx_theme_raw.png   | Bin 0 -> 8577 bytes
 4 files changed, 23 insertions(+), 3 deletions(-)
 create mode 100644 docs/screenshot.png
 create mode 100644 docs/tyrian_sphinx_theme_label.png
 create mode 100644 docs/tyrian_sphinx_theme_raw.png

diff --git a/README.md b/README.md
index 32b3aa3..cb65573 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,17 @@
-# Tyrian Sphinx Theme
+<p align="center"><img width=17.5% src="https://raw.githubusercontent.com/mmagorsc/tyrian_sphinx_theme/master/docs/tyrian_sphinx_theme_raw.png"></p>
+<p align="center"><img width=60% src="https://raw.githubusercontent.com/mmagorsc/tyrian_sphinx_theme/master/docs/tyrian_sphinx_theme_label.png"></p>
 
-A Sphinx theme based on Tyrian (the new unified gentoo.org theme). 
+<p align="center">
+<a href="https://www.python.org/" ><img src="https://img.shields.io/badge/python-2.6%2B-blue.svg"></a>
+<a> <img src="https://github.com/mmagorsc/tyrian_sphinx_theme/workflows/Upload%20Python%20Package/badge.svg"></a>
+<a href="https://pypi.org/project/tyrian-sphinx-theme/"><img src="https://badge.fury.io/py/tyrian-sphinx-theme.svg" alt="PyPI version" height="18"></a>
+<a href="#contributing"> <img src="https://img.shields.io/badge/contributions-welcome-orange.svg"></a>
+<a href="https://opensource.org/licenses/BSD-2-Clause"><img src="https://img.shields.io/badge/license-BSD-blue.svg"></a>
+</p>
 
+## Table Of Contents 
 
+- [Basic Overview](#basic-overview)
 - [Installation](#installation)
 - [Configuration](#configuration)
     - [builders](#builders)
@@ -13,6 +22,13 @@ A Sphinx theme based on Tyrian (the new unified gentoo.org theme).
     - [license](#license)
     - [license_link](#license_link)
 - [Contributors](#contributors)
+- [Contributing](#contributing)
+
+## Basic Overview
+
+A Sphinx theme based on Tyrian (the new unified gentoo.org theme). 
+
+[![Screenshoot](https://raw.githubusercontent.com/mmagorsc/taskmonad/master/docs/screenshot.png)](https://projects.gentoo.org/qa/policy-guide/)
 
 ## Installation
 You can use pip to install the theme: 
@@ -69,4 +85,8 @@ $ sphinx-build -b singlehtml ...
 - https://creativecommons.org/licenses/by-sa/4.0/ *(default)*
 
 ## Contributors
-* [Max Magorsch](mailto:max@magorsch.de)
\ No newline at end of file
+* [Max Magorsch](mailto:max@magorsch.de)
+
+## Contributing
+
+Contributions are welcome. You have an idea, suggestion for improvement or have found a bug? Just create an issue or send a pull request.
\ No newline at end of file
diff --git a/docs/screenshot.png b/docs/screenshot.png
new file mode 100644
index 0000000..70e8725
Binary files /dev/null and b/docs/screenshot.png differ
diff --git a/docs/tyrian_sphinx_theme_label.png b/docs/tyrian_sphinx_theme_label.png
new file mode 100644
index 0000000..6b70c8e
Binary files /dev/null and b/docs/tyrian_sphinx_theme_label.png differ
diff --git a/docs/tyrian_sphinx_theme_raw.png b/docs/tyrian_sphinx_theme_raw.png
new file mode 100644
index 0000000..ef6cabb
Binary files /dev/null and b/docs/tyrian_sphinx_theme_raw.png differ
-- 
cgit v1.2.3-65-gdbad