diff options
authorBryan Brattlof <hello@bryanbrattlof.com>2020-06-30 10:50:26 -0400
committerBryan Brattlof <hello@bryanbrattlof.com>2020-06-30 12:46:31 -0400
commitdd82df5572813de5c9ace93fe3fcb358df598e3f (patch)
parent6a327ec749bc4af809f91a2c34658fb0582497ac (diff)
update links & contributing in readme1.0.2
giving this to Jordan for review, she says the new description for HTMLMIN_ENABLED better conveys the idea that you can override the default behavior. added my donation link and added a MIT license badge from shields.io
1 files changed, 13 insertions, 7 deletions
diff --git a/readme.rst b/readme.rst
index e184b24..92aa194 100644
--- a/readme.rst
+++ b/readme.rst
@@ -35,7 +35,7 @@ Installing
$ pip install pelican-htmlmin
After you've installed the package, update the :code:`PLUGINS` variable in your
-:code:`pelicanconf.py` to include the package in the next pelican build.
+:code:`pelicanconf.py` to include the package in your next pelican build.
.. code-block:: python
@@ -54,10 +54,10 @@ that you may need.
-If Pelican is in :code:`DEBUG` mode, :code:`pelican-htmlmin` will not minify
-files to help with debugging. You only need to set
-:code:`HTMLMIN_ENABLED = True` if you want to minify your HTML files while
-:code:`DEBUG` is set.
+By Default, if Pelican is in :code:`DEBUG` mode, :code:`pelican-htmlmin` will
+not minify any files, helping with debugging. To override this, set
+:code:`HTMLMIN_ENABLED = True` to minify your HTML files regardless of the
+:code:`DEBUG` flag.
.. code-block:: python
@@ -96,5 +96,11 @@ For more information on the arguments you can give :code:`htmlmin`, see their
-Please feel free to help. Issues, pull requests, and `patches via email
-<https://bryanbrattlof.com/connect/>`_, all are warmly welcomed.
+Please feel free to help. `Buying me Beer
+<https://www.buymeacoffee.com/bryanbrattlof>`_, emailing issues, or `patches via
+email <https://bryanbrattlof.com/connect/>`_, are all warmly welcomed,
+especially beer.
+.. image:: https://img.shields.io/badge/license-MIT-green.svg
+ :alt: License: MIT