From 16c1fd4643d7b716f7fcb715d3109f8461816f7a Mon Sep 17 00:00:00 2001
From: Radi Mustafa <rmustafa@cocus.com>
Date: Sun, 29 Nov 2020 11:15:19 +0100
Subject: [PATCH] update docs for 2.5.0 release

---
 README.rst                | 43 ++++++++++++++++++++++++---------------
 VERSION                   |  2 +-
 docs/source/Changelog.rst | 11 +++++++++-
 docs/source/usage.rst     |  6 ++++++
 4 files changed, 44 insertions(+), 18 deletions(-)

diff --git a/README.rst b/README.rst
index b84065e..5c15719 100644
--- a/README.rst
+++ b/README.rst
@@ -1,19 +1,3 @@
-.. image:: https://badge.fury.io/py/django-comments-dab.svg
-    :target: https://pypi.org/project/django-comments-dab/
-    :alt: pypi
-
-.. image:: https://img.shields.io/github/v/tag/radi85/Comment?color=gr
-    :target: https://github.com/Radi85/Comment/releases
-    :alt: tag
-
-.. image:: https://travis-ci.org/Radi85/Comment.svg?branch=master
-    :target: https://travis-ci.org/Radi85/Comment
-    :alt: build
-
-.. image:: https://coveralls.io/repos/github/Radi85/Comment/badge.svg
-    :target: https://coveralls.io/github/Radi85/Comment
-    :alt: coverage
-
 .. image:: https://img.shields.io/pypi/pyversions/django-comments-dab.svg
     :target: https://pypi.python.org/pypi/django-comments-dab/
     :alt: python
@@ -22,6 +6,14 @@
     :target: https://pypi.python.org/pypi/django-comments-dab/
     :alt: django
 
+.. image:: https://coveralls.io/repos/github/Radi85/Comment/badge.svg
+    :target: https://coveralls.io/github/Radi85/Comment
+    :alt: coverage
+
+.. image:: https://travis-ci.org/Radi85/Comment.svg?branch=master
+    :target: https://travis-ci.org/Radi85/Comment
+    :alt: build
+
 .. image:: https://readthedocs.org/projects/django-comment-dab/badge/?version=latest
     :target: https://django-comment-dab.readthedocs.io/?badge=latest
     :alt: docs
@@ -37,6 +29,25 @@
 .. image:: https://img.shields.io/pypi/dm/django-comments-dab
     :alt: downloads
 
+.. image:: https://badge.fury.io/py/django-comments-dab.svg
+    :target: https://pypi.org/project/django-comments-dab/
+    :alt: pypi
+
+.. image:: https://img.shields.io/github/v/tag/radi85/Comment?color=gr
+    :target: https://github.com/Radi85/Comment/releases
+    :alt: tag
+
+.. image:: https://img.shields.io/github/release-date/radi85/comment?color=blue
+    :target: #
+    :alt: Django-comment-dab Release Date
+
+.. image:: https://img.shields.io/github/commits-since/radi85/comment/latest/master
+    :target: #
+    :alt: Commits since latest release for a branch master
+
+.. image:: https://img.shields.io/github/last-commit/radi85/comment?color=blue
+    :target: #
+    :alt: Django-comment-dab last commit
 
 ===================
 django-comments-dab
diff --git a/VERSION b/VERSION
index 6eaf894..fad066f 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-v2.0.0
\ No newline at end of file
+2.5.0
\ No newline at end of file
diff --git a/docs/source/Changelog.rst b/docs/source/Changelog.rst
index 6dc34fd..4818ae7 100644
--- a/docs/source/Changelog.rst
+++ b/docs/source/Changelog.rst
@@ -1,13 +1,22 @@
 Changelog
 =========
 
+2.5.0
+------
+
+- Add django 3.1 compatibility.
+- Add gravatar support.
+- Add i18n support.
+- Include static files implicitly. ``include_static`` template tag is deprecated.
+- Bugs fixes.
+
 2.0.0
 ------
 
 - Allow commenting by unauthenticated users (Anonymous comment).
 - Add permalink to comments.
 - Remove JQuery from dependencies and replace it with Vanilla JS.
-- Update mixins and add content type and parent id validators.
+- Update mixin and add content type and parent id validators.
 - Bug fixes.
 
 1.6.7
diff --git a/docs/source/usage.rst b/docs/source/usage.rst
index 579cbbc..d82e3ee 100644
--- a/docs/source/usage.rst
+++ b/docs/source/usage.rst
@@ -183,3 +183,9 @@ Also, related to sending of email the following settings need to set.
 To further customize different attributes related to anonymous commenting, you may look into the `Settings`_ section for different configurations.
 
 .. _`Settings`: https://django-comment-dab.readthedocs.io/settings.html/
+
+
+5. Enable gravatar:
+^^^^^^^^^^^^^^^^^^^^
+
+To enable using gravatar for profile pics set ``COMMENT_USE_GRAVATAR`` in settings.py to ``True``