first commit

1 files changed, 24 insertions, 0 deletions

diff --git a/plugins/get_app_version/README.md b/plugins/get_app_version/README.md
new file mode 100644
index 0000000..3233051
--- /dev/null
+++ b/plugins/get_app_version/README.md
@@ -0,0 +1,24 @@
+App version
+============
+
+A Pelican plugin to show app version from git.
+
+Copyright (c) 2020 - Jesús E.
+
+How to use
+==========
+
+In your pelicanconf.py, add:
+
+    PLUGINS = ['get_app_version']
+
+In your template, add:
+
+    {% if CURRENT_VERSION and CURRENT_BRANCH %}
+      <h6>{{ _('Current version:') }} {{ CURRENT_VERSION }} @ {{ CURRENT_BRANCH }}</h6>
+    {% endif %}
+
+License
+=======
+
+This work is under the License [GNU GPLv3+](LICENSE)