file updated

lnxpy · lnxpy · commit 10c8781d3dd8 · 2022-08-30T00:42:49.000+04:30
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,7 +1,6 @@
-include CONTRIBUTING.rst
-include HISTORY.rst
+include CONTRIBUTING.md
 include LICENSE
-include README.rst
+include README.md
 
 recursive-include tests *
 recursive-exclude * __pycache__
diff --git a/README.md b/README.md
@@ -0,0 +1,39 @@
+## django-psdb-engine
+
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/django-psdb-engine) ![PyPI - Downloads](https://img.shields.io/pypi/dm/django-psdb-engine) ![Made for - PlanetScale](https://img.shields.io/badge/made%20for-PlanetScale-black?style=flat&logo=planetscale)
+
+This package helps you interact with your [PlanetScale](https://planetscale.com) databases in your Django projects in an easier way.
+
+### Usage
+
+Install the package by running the following command.
+
+```sh
+pip install django-psdb-engine
+```
+
+And finally, update your `DATABASES` configuration and change the `ENGINE` field.
+
+```python
+DATABASES = {
+  'default': {
+    'ENGINE': 'django_psdb_engine',
+    ...
+    'OPTIONS': {'ssl': {'ca': ...}}
+  }
+}
+```
+
+**Note**: Since Django uses the `UTF-8` charset and it points to `utf8mb3` in MySQL and this charset is deprecated in MySQL 8, you may need to add `{"charset": "utf8mb4"}` and migrate your chanegs with no problem.
+
+```diff
+-'OPTIONS': {'ssl': {'ca': os.environ.get('MYSQL_ATTR_SSL_CA')}}
++'OPTIONS': {'ssl': {'ca': os.environ.get('MYSQL_ATTR_SSL_CA')}, 'charset': 'utf8mb4'}
+```
+
+### Requirements
+- django >= 2.2
+- mysqlclient >= 2.1.0
+
+### License
+Free software: [MIT license](LICENSE)
diff --git a/setup.py b/setup.py
@@ -4,12 +4,9 @@
 
 from setuptools import find_packages, setup
 
-with open("README.rst") as readme_file:
+with open("README.md") as readme_file:
     readme = readme_file.read()
 
-with open("HISTORY.rst") as history_file:
-    history = history_file.read()
-
 requirements = [
     "django>=2.2",
     "mysqlclient>=2.1.0",
@@ -34,7 +31,7 @@
     description="Django PlanetScale database engine.",
     install_requires=requirements,
     license="MIT license",
-    long_description=readme + "\n\n" + history,
+    long_description=readme,
     include_package_data=True,
     keywords="django_psdb_engine",
     name="django_psdb_engine",
