Update README, and update required Python version

ipython-contrib · Feb 19, 2024 · ffe15e5 · ffe15e5
1 parent a9c5169
commit ffe15e5
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,8 +1,13 @@
 # ipython-markdown-inspector
 
+Provides IPython inspector outputs as Markdown, enabling better integration with Jupyter Notebook and JupyterLab. Depends on [`docstring-to-markdown`](https://github.com/python-lsp/docstring-to-markdown).
+
+![](https://raw.githubusercontent.com/krassowski/ipython-markdown-inspector/main/docs/demo.gif)
 
 ## Installation
 
+Requires `IPython` 8.21 or newer (which requires Python 3.10 or newer).
+
 ```
 pip install ipython-markdown-inspector
 ```

diff --git a/docs/demo.png b/docs/demo.png
diff --git a/pyproject.toml b/pyproject.toml
@@ -9,7 +9,7 @@ dependencies = [
   "ipython>=8.21.0",
   "docstring-to-markdown>=0.13,<1.0"
 ]
-requires-python = ">=3.8"
+requires-python = ">=3.10"
 authors = [
   {name = "Michał Krassowski"}
 ]