From fbd2b5e08c032610ba895c0c66bc1f3fe9e08c9b Mon Sep 17 00:00:00 2001 From: greyllmmoder Date: Sun, 5 Apr 2026 13:17:02 +0530 Subject: [PATCH] docs: add standard developer integration instructions --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index 3fa8e2b..c42417e 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,31 @@ pip install "aztec-py[decode]" # Decode utility via python-zxing + Java pip install "aztec-py[svg]" # lxml-backed SVG workflows (optional) ``` +## Use In Your Project + +Recommended dependency pins for production: + +`requirements.txt` +```text +aztec-py>=0.11,<1.0 +``` + +`pyproject.toml` (PEP 621) +```toml +[project] +dependencies = [ + "aztec-py>=0.11,<1.0", +] +``` + +Install directly from GitHub when you need an unreleased fix: + +```bash +pip install "aztec-py @ git+https://github.com/greyllmmoder/python-aztec.git@" +``` + +For production, pin to a tag or commit SHA, not `main`. + ## Quick Start ```python