Add README.md

.gitignore

@@ -135,4 +135,7 @@ dmypy.json
 .pytype/
 
 # Cython debug symbols
-cython_debug/
+cython_debug/
+
+# PyCharm project
+.idea/

README.md

@@ -0,0 +1,36 @@
+# PyXLL-Jupyter
+
+Integration for Jupyter notebooks and Microsoft Excel.
+
+Requires:
+
+- PyXLL >= 5.0.0
+- Jupyter
+- PySide2
+
+To install this package use:
+
+    pip install pyxll-jupyter
+
+Once installed a "Jupyter Notebook" button will be added to the PyXLL ribbon tab in Excel, so
+long as you have PyXLL 5 or above already installed.
+
+When using Jupyter in Excel the Python kernel runs inside the Excel process using PyXLL. You
+can interact with Excel from code in the Jupyter notebook, and write Excel functions
+using the PyXLL decorators @xl_menu and @xl_macro etc.
+
+As the kernel runs in the existing Python interpreter in the Excel process it is not possible
+to restart the kernel or to use other Python versions or other languages.
+
+To configure add the following to your pyxll.cfg file (default values shown):
+
+    [JUPYTER]
+    use_workbook_dir = 0
+    notebook_dir = Documents
+
+If *use_workbook_dir* is set and the current workbook is saved then Jupyter will open in the same folder
+as the current workbook.
+
+For more information about installing and using PyXLL see https://www.pyxll.com.
+
+Copyright (c) 2020 PyXLL Ltd

setup.py

@@ -1,9 +1,38 @@
+"""
+PyXLL-Jupyter
+
+This package integrated Jupyter notebooks into Microsoft Excel.
+
+To install it, first install PyXLL (see https://www.pyxll.com).
+
+Briefly, to install PyXLL do the following::
+
+    pip install pyxll
+    pyxll install
+
+Once PyXLL is installed then installing this package will add a
+button to the PyXLL ribbon toolbar that will start a Jupyter
+notebook browser as a custom task pane in Excel.
+
+To install this package use::
+
+    pip install pyxll_jupyter
+"""
 from setuptools import setup, find_packages
+from os import path
+
+
+this_directory = path.abspath(path.dirname(__file__))
+with open(path.join(this_directory, 'README.md'), encoding='utf-8') as f:
+    long_description = f.read()
+
 
 setup(
     name="pyxll_jupyter",
     description="Adds Jupyter notebooks to Microsoft Excel using PyXLL.",
-    version="0.1.6",
+    long_description=long_description,
+    long_description_content_type='text/markdown',
+    version="0.1.7",
     packages=find_packages(),
     include_package_data=True,
     package_data={
@@ -12,14 +41,19 @@
             "pyxll_jupyter/resources/jupyter.png",
         ]
     },
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: Microsoft :: Windows"
+    ],
     entry_points={
         "pyxll": [
             "modules = pyxll_jupyter.pyxll:modules",
             "ribbon = pyxll_jupyter.pyxll:ribbon"
         ]
     },
     install_requires=[
-        #"pyxll >= 5.0.0",
+        "pyxll >= 5.0.0",
         "jupyter >= 1.0.0",
         "PySide2"
     ]