From fb398efc731f763015acab686b3c07ddc7ca804e Mon Sep 17 00:00:00 2001
From: Jared McFarland <jared@mixpanel.com>
Date: Tue, 9 Dec 2025 09:51:49 -0800
Subject: [PATCH] Convert README from reStructuredText to Markdown

- Convert README.rst to README.md for better GitHub rendering
- Maintain all original content and links
- Update code blocks to use markdown syntax with proper highlighting
- Convert badges to markdown format
- Add DeepWiki badge for additional documentation support
---
 README.md  | 48 +++++++++++++++++++++++++++++++++++++++
 README.rst | 66 ------------------------------------------------------
 2 files changed, 48 insertions(+), 66 deletions(-)
 create mode 100644 README.md
 delete mode 100644 README.rst

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..35586b5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,48 @@
+# mixpanel-python
+
+[![PyPI](https://img.shields.io/pypi/v/mixpanel)](https://pypi.org/project/mixpanel)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mixpanel)](https://pypi.org/project/mixpanel)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/mixpanel)](https://pypi.org/project/mixpanel)
+![Tests](https://github.com/mixpanel/mixpanel-python/workflows/Tests/badge.svg)
+
+This is the official Mixpanel Python library. This library allows for
+server-side integration of Mixpanel.
+
+To import, export, transform, or delete your Mixpanel data, please see our
+[mixpanel-utils package](https://github.com/mixpanel/mixpanel-utils).
+
+## Installation
+
+The library can be installed using pip:
+
+```bash
+pip install mixpanel
+```
+
+## Getting Started
+
+Typical usage usually looks like this:
+
+```python
+from mixpanel import Mixpanel
+
+mp = Mixpanel(YOUR_TOKEN)
+
+# tracks an event with certain properties
+mp.track(DISTINCT_ID, 'button clicked', {'color' : 'blue', 'size': 'large'})
+
+# sends an update to a user profile
+mp.people_set(DISTINCT_ID, {'$first_name' : 'Ilya', 'favorite pizza': 'margherita'})
+```
+
+You can use an instance of the Mixpanel class for sending all of your events
+and people updates.
+
+## Additional Information
+
+* [Help Docs](https://www.mixpanel.com/help/reference/python)
+* [Full Documentation](http://mixpanel.github.io/mixpanel-python/)
+* [mixpanel-python-async](https://github.com/jessepollak/mixpanel-python-async); a third party tool for sending data asynchronously
+from the tracking python process.
+
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/mixpanel/mixpanel-python)
diff --git a/README.rst b/README.rst
deleted file mode 100644
index 565ffab..0000000
--- a/README.rst
+++ /dev/null
@@ -1,66 +0,0 @@
-mixpanel-python
-==============================
-
-.. image:: https://img.shields.io/pypi/v/mixpanel
-    :target: https://pypi.org/project/mixpanel
-    :alt: PyPI
-
-.. image:: https://img.shields.io/pypi/pyversions/mixpanel
-    :target: https://pypi.org/project/mixpanel
-    :alt: PyPI - Python Version
-
-.. image:: https://img.shields.io/pypi/dm/mixpanel
-    :target: https://pypi.org/project/mixpanel
-    :alt: PyPI - Downloads
-
-.. image:: https://github.com/mixpanel/mixpanel-python/workflows/Tests/badge.svg
-
-This is the official Mixpanel Python library. This library allows for
-server-side integration of Mixpanel.
-
-To import, export, transform, or delete your Mixpanel data, please see our
-`mixpanel-utils package`_.
-
-
-Installation
-------------
-
-The library can be installed using pip::
-
-    pip install mixpanel
-
-
-Getting Started
----------------
-
-Typical usage usually looks like this::
-
-    from mixpanel import Mixpanel
-
-    mp = Mixpanel(YOUR_TOKEN)
-
-    # tracks an event with certain properties
-    mp.track(DISTINCT_ID, 'button clicked', {'color' : 'blue', 'size': 'large'})
-
-    # sends an update to a user profile
-    mp.people_set(DISTINCT_ID, {'$first_name' : 'Ilya', 'favorite pizza': 'margherita'})
-
-You can use an instance of the Mixpanel class for sending all of your events
-and people updates.
-
-
-Additional Information
-----------------------
-
-* `Help Docs`_
-* `Full Documentation`_
-* mixpanel-python-async_; a third party tool for sending data asynchronously
-  from the tracking python process.
-
-
-.. |travis-badge| image:: https://travis-ci.org/mixpanel/mixpanel-python.svg?branch=master
-    :target: https://travis-ci.org/mixpanel/mixpanel-python
-.. _mixpanel-utils package: https://github.com/mixpanel/mixpanel-utils
-.. _Help Docs: https://www.mixpanel.com/help/reference/python
-.. _Full Documentation: http://mixpanel.github.io/mixpanel-python/
-.. _mixpanel-python-async: https://github.com/jessepollak/mixpanel-python-async