From c694bd9ae12ee4cb9b04dcac0384282eb9bf4715 Mon Sep 17 00:00:00 2001
From: Mike <mike@graywind.org>
Date: Sat, 9 Mar 2024 22:24:57 -0600
Subject: [PATCH] chore(docs): add a long description to PyPi (#429)

partially fulfills #390
---
 setup.py | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/setup.py b/setup.py
index 2eff11354b9..cecb0a70642 100644
--- a/setup.py
+++ b/setup.py
@@ -54,12 +54,17 @@ def required(requirements_file):
                 if pkg.strip() and not pkg.startswith("#")]
 
 
+with open("README.md", "r") as f:
+    long_description = f.read()
+
 setup(
     name='ovos-core',
     version=get_version(),
     license='Apache-2.0',
     url='https://github.com/OpenVoiceOS/ovos-core',
-    description='mycroft-core packaged as a library',
+    description='The spiritual successor to Mycroft AI, OVOS is flexible voice assistant software that can be run almost anywhere!',
+    long_description=long_description,
+    long_description_content_type="text/markdown",
     install_requires=required('requirements/requirements.txt'),
     extras_require={
         'mycroft': required('requirements/mycroft.txt'),