setup: add long description

bretello · Apr 17, 2024 · 0f0ca8e · 0f0ca8e
1 parent edff98b
commit 0f0ca8e
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -13,6 +13,7 @@ on:
 
 jobs:
   tests:
+    name: Lint
     runs-on: ${{ matrix.os }}
 
     strategy:

diff --git a/setup.py b/setup.py
@@ -1,5 +1,8 @@
 from setuptools import setup
 
+with open("README.md") as fh:
+    long_description = fh.read()
+
 setup(
     name="fancycompleter",
     setup_requires=["setuptools_scm"],
@@ -13,6 +16,8 @@
     author_email="[email protected]",
     license="BSD",
     description="colorful TAB completion for Python prompt",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
     keywords="rlcompleter prompt tab color completion",
     classifiers=[
         "Development Status :: 4 - Beta",
-Original file line number
+Diff line change
@@ Expand Up / @@ -13,6 +13,7 @@ on: @@
     jobs:
       tests:
+        name: Lint
         runs-on: ${{ matrix.os }}
         strategy:
@@ Expand Down @@