Add default value for gitstamp_fmt to README

jdillard · Sep 27, 2023 · b2741ad · b2741ad
1 parent c10c63d
commit b2741ad
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/README.rst b/README.rst
@@ -21,13 +21,13 @@ For example:
 
    extensions = ['sphinx_gitstamp']
 
-Set the value of ``gitstamp_fmt`` in **conf.py** to the desired `time format`_.
+To change the default time format of ``%b %d, %Y``, set the value of ``gitstamp_fmt`` in **conf.py** to the desired `time format`_.
 For example:
 
 .. code-block:: python
 
    # Date format for git timestamps
-   gitstamp_fmt = "%b %d, %Y"
+   gitstamp_fmt = "%Y-%m-%d %H:%M:%S %z"
 
 Add ``gitstamp`` to the jinja template, for example: