diff --git a/README.md b/README.md index c74c84ef..850972fa 100644 --- a/README.md +++ b/README.md @@ -53,10 +53,12 @@ OSXPhotos uses setuptools, thus simply run: python3 setup.py install -You can also install directly from [pypi](https://pypi.org/): +You can also install directly from [pypi](https://pypi.org/project/osxphotos/): pip install osxphotos +**WARNING** The git repo for this project is very large (> 1GB) because it contains multiple Photos libraries used for testing on different versions of MacOS. If you just want to use the osxphotos package in your own code, I recommend you install the latest version from [PyPI](https://pypi.org/project/osxphotos/). If you just want to use the command line utility, you can download a pre-built executable of the latest [release](https://github.com/RhetTbull/osxphotos/releases) or you can install via `pip` which also installs the command line app. If you aren't comfortable with running python on your Mac, start with the pre-built executable. + ## Command Line Usage This package will install a command line utility called `osxphotos` that allows you to query the Photos database. Alternatively, you can also run the command line utility like this: `python3 -m osxphotos`