Move project description to README.MD

Fixes #831

README.md

@@ -1,9 +1,20 @@
-# Read Me
+# Radicale
 
 [![Test](https://github.com/Kozea/Radicale/actions/workflows/test.yml/badge.svg?branch=v3)](https://github.com/Kozea/Radicale/actions/workflows/test.yml)
 [![Coverage Status](https://coveralls.io/repos/github/Kozea/Radicale/badge.svg?branch=v3)](https://coveralls.io/github/Kozea/Radicale?branch=v3)
 
-Radicale is a free and open-source CalDAV and CardDAV server.
+Radicale is a small but powerful CalDAV (calendars, to-do lists) and CardDAV
+(contacts) server, that:
+
+* Shares calendars and contact lists through CalDAV, CardDAV and HTTP.
+* Supports events, todos, journal entries and business cards.
+* Works out-of-the-box, no complicated setup or configuration required.
+* Can limit access by authentication.
+* Can secure connections with TLS.
+* Works with many CalDAV and CardDAV clients
+* Stores all data on the file system in a simple folder structure.
+* Can be extended with plugins.
+* Is GPLv3-licensed free software.
 
 For the complete documentation, please visit
 [Radicale v3 Documentation](https://radicale.org/v3.html).

setup.py

@@ -15,31 +15,15 @@
 # You should have received a copy of the GNU General Public License
 # along with Radicale.  If not, see <http://www.gnu.org/licenses/>.
 
-"""
-Radicale CalDAV and CardDAV server
-==================================
-
-The Radicale Project is a CalDAV (calendar) and CardDAV (contact) server.  It
-aims to be a light solution, easy to use, easy to install, easy to configure.
-As a consequence, it requires few software dependances and is pre-configured to
-work out-of-the-box.
-
-The Radicale Project runs on most of the UNIX-like platforms (Linux, BSD,
-MacOS X) and Windows.  It is known to work with Evolution, Lightning, iPhone
-and Android clients. It is free and open-source software, released under GPL
-version 3.
-
-For further information, please visit the `Radicale Website
-<https://radicale.org/>`_.
-
-"""
-
 from setuptools import find_packages, setup
 
 # When the version is updated, a new section in the CHANGELOG.md file must be
 # added too.
 VERSION = "3.1.7"
-WEB_FILES = ["web/internal_data/css/icon.png",
+
+with open("README.md", encoding="utf-8") as f:
+    long_description = f.read()
+web_files = ["web/internal_data/css/icon.png",
              "web/internal_data/css/main.css",
              "web/internal_data/fn.js",
              "web/internal_data/index.html"]
@@ -55,15 +39,16 @@
     name="Radicale",
     version=VERSION,
     description="CalDAV and CardDAV Server",
-    long_description=__doc__,
+    long_description=long_description,
+    long_description_content_type="text/markdown",
     author="Guillaume Ayoub",
     author_email="[email protected]",
     url="https://radicale.org/",
     license="GNU GPL v3",
     platforms="Any",
     packages=find_packages(
         exclude=["*.tests", "*.tests.*", "tests.*", "tests"]),
-    package_data={"radicale": [*WEB_FILES, "py.typed"]},
+    package_data={"radicale": [*web_files, "py.typed"]},
     entry_points={"console_scripts": ["radicale = radicale.__main__:run"]},
     install_requires=install_requires,
     extras_require={"test": test_requires, "bcrypt": bcrypt_requires},