From 6275694d1b06de2b952de2f026e28c9f0906bd4b Mon Sep 17 00:00:00 2001 From: Jennifer Taylor Date: Mon, 4 Oct 2021 02:41:46 +0000 Subject: [PATCH] Include note about using package. --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index b756429..c1a993b 100644 --- a/README.md +++ b/README.md @@ -72,3 +72,13 @@ The tools are also lint clean (save for line length lints which are useless driv ``` flake8 --ignore E501 . ``` + +## Including This Package + +By design, this code can be used as a library by other python code, and as it is Public Domain, +it can be included wherever. I would prefer that you attribute me when possible, but it is not +necessary. There is currently no PyPI package for arcadeutils, but if you clone the repo and +run `pip install .` on the root, the package will be installed for you. Alternatively if you +place the line `git+https://github.com/DragonMinded/arcadeutils.git@main#egg=arcadeutils` in your +requirements file, then when you run `pip install -r requirements.txt` on your own code, the latest +version of this package will be installed for you.