diff --git a/README.md b/README.md index 1f7f1ab..c733794 100644 --- a/README.md +++ b/README.md @@ -8,12 +8,10 @@ file formats include [glTF/glB](https://www.khronos.org/gltf/) and [USD](https:/ ## Installation -This package is not (yet) listed on PyPI, so to install you'll need to clone this repository and install from source. +This package is pip-installable: ``` -git clone https://github.com/Carifio24/glue-ar -cd glue-ar -pip install . # Use `pip install -e .` to install in editable mode +pip install glue-ar ``` Installation requires Node.js to be installed on your system, as we currently use JavaScript packages for performing diff --git a/setup.py b/setup.py index 3a5d1f2..8a1da1c 100644 --- a/setup.py +++ b/setup.py @@ -727,10 +727,15 @@ def data_files(root_directory): ) cmdclass["js-content"] = js_content_command +with open("README.md", 'r') as f: + description = f.read() + # TODO: Add the rest of the package data setup_args = dict( name=name, cmdclass=cmdclass, + long_description=description, + long_description_content_type="text/markdown", python_requires=">=3.9", zip_safe=False, packages=find_packages(name, exclude=["js"]),