Add gif demonstration to readme

JakobGM · Feb 22, 2018 · b5a6e25 · b5a6e25
1 parent 47d2644
commit b5a6e25
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 2 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -125,7 +125,7 @@
 }
 
 # Logo for the documentation
-html_logo = 'astrality_logo.png'
+html_logo = 'images/astrality_logo.png'
 
 
 # -- Options for HTMLHelp output ------------------------------------------

diff --git a/docs/astrality_logo.png → docs/images/astrality_logo.png b/docs/astrality_logo.png → docs/images/astrality_logo.png
diff --git a/docs/astrality_logo.svg → docs/images/astrality_logo.svg b/docs/astrality_logo.svg → docs/images/astrality_logo.svg
diff --git a/docs/readme.rst b/docs/readme.rst
@@ -13,7 +13,7 @@
     :target: http://astrality.readthedocs.io/en/latest/?badge=latest
     :alt: Documentation Status
 
-.. |logo| image:: https://github.com/JakobGM/astrality/raw/master/docs/astrality_logo.png
+.. |logo| image:: https://github.com/JakobGM/astrality/raw/master/docs/images/astrality_logo.png
 
 =====================================================================================================
 |logo| Astrality - A Dynamic Configuration File Manager |pypi_version| |travis-ci| |rtfd| |coveralls|
@@ -26,6 +26,14 @@ Astrality is a tool for managing configuration files and scheduling tasks relate
 
 You can create templates for your configuration files, and Astrality will replace placeholders within those templates with ``context`` values defined in a central configuration file. Furthermore, you can dynamically manipulate that ``context`` at predefined times and events.
 
+**Here is gif demonstrating how Astrality is used to**:
+
+1) Change to the same color scheme of `alacritty <https://github.com/jwilm/alacritty>`_, `kitty <https://github.com/kovidgoyal/kitty>`_, and `polybar <https://github.com/jaagr/polybar>`_ at the same time.
+2) Automatically change the desktop wallpaper based on the sun's position in the sky.
+3) Dynamically change the font size of Polybar.
+
+.. image:: https://i.imgur.com/1hcP4fA.gif
+
 **Possible use cases are:**
 
 * Create a single source of truth for configuration options. Change your preferred font type or color scheme, and see that change be applied across several different graphical applications.