Merge pull request #36 from AdrianDsg/adriandsg/improve-contents

Add README.md to PyPi page and remove Python 3.7 support

.github/workflows/test.yml

@@ -14,10 +14,10 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v4

README.md

@@ -4,7 +4,7 @@
 
 An MkDocs plugin to minify HTML, JS or CSS files prior to being written to disk.
 
-HTML minification is done using [htmlmin](https://github.com/mankyd/htmlmin).
+HTML minification is done using [htmlmin2](https://github.com/wilhelmer/htmlmin).
 
 JS minification is done using [jsmin](https://github.com/tikitu/jsmin/).
 
@@ -42,7 +42,7 @@ plugins:
 
 ## Options
 
-- `minify_html`: 
+- `minify_html`:
   - Defaults to `False`.
   - Sets whether HTML files should be minified.
 - `minify_js`:
@@ -53,7 +53,7 @@ plugins:
   - Defaults to `False`.
   - Sets whether CSS files should be minified.<br>
     If set to `True`, you must specify the CSS to be minified files using `css_files` (see below).
-- `htmlmin_opts`: 
+- `htmlmin_opts`:
   - Defaults to `None`.
   - Sets runtime htmlmin API options using the [config parameters of htmlmin](https://htmlmin.readthedocs.io/en/latest/reference.html#main-functions)
 - `cache_safe`:

setup.py

@@ -1,16 +1,22 @@
 from setuptools import find_packages, setup
+from pathlib import Path
+
+# read contents of README.md to include it in package metadata
+readme_file = Path(__file__).parent / "README.md"
+long_description = readme_file.read_text("utf-8")
 
 setup(
     name="mkdocs-minify-plugin",
     version="0.7.1",
     description="An MkDocs plugin to minify HTML, JS or CSS files prior to being written to disk",
-    long_description="",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
     keywords="mkdocs minify publishing documentation html css",
     url="https://github.com/byrnereese/mkdocs-minify-plugin",
     author="Byrne Reese, Lars Wilhelmer",
     author_email="byrne@majordojo.com",
     license="MIT",
-    python_requires=">=3.7",
+    python_requires=">=3.8",
     install_requires=[
         "mkdocs>=1.4.1",
         "htmlmin2>=0.1.13",
@@ -24,7 +30,6 @@
         "License :: OSI Approved :: MIT License",
         "Programming Language :: Python",
         "Programming Language :: Python :: 3 :: Only",
-        "Programming Language :: Python :: 3.7",
         "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",