Merge pull request #14 from bbednarski9/fix/issue-10-readme-requirements

Complete README third-party plugin guidance

Author: justin-cechmanek

README.md

@@ -49,10 +49,25 @@ Toolkit. The setuptools entry point **`nat_redis`** loads
 
 ## Install
 
+With `uv`:
+
+```bash
+uv add nemo-agent-toolkit-redis
+```
+
+With `pip`:
+
 ```bash
 pip install nemo-agent-toolkit-redis
 ```
 
+Install the package into the same Python environment as `nvidia-nat-core`. After
+installation, confirm NAT can discover the Redis plugin:
+
+```bash
+uv run nat info components
+```
+
 For local development in this repo:
 
 ```bash
@@ -61,6 +76,12 @@ cd nvidia-nat-redis
 uv sync --group dev --extra test
 ```
 
+## Compatibility
+
+This package supports NeMo Agent Toolkit `>=1.6.0,<2.0.0` and Python
+`>=3.11,<3.14`. Compatibility is checked in CI against supported NAT minor
+versions.
+
 ## Choose A Surface
 
 - Use `_type: redis_agent_memory_backend` when your workflow already uses NAT memory tools and you want Redis Agent Memory behind the standard `MemoryEditor` contract.
@@ -154,3 +175,17 @@ The example Compose files are intended for local development. They bind Redis
 and AMS to `127.0.0.1` and run AMS with auth disabled.
 
 See [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## Support
+
+File Redis integration bugs, Redis Agent Memory behavior questions, and package
+release issues in this repository:
+<https://github.com/redis-developer/nemo-agent-toolkit-redis/issues>.
+
+File `nvidia-nat-core` runtime, loader, or public plugin API issues in the
+NeMo Agent Toolkit repository:
+<https://github.com/NVIDIA/NeMo-Agent-Toolkit/issues>.
+
+## License
+
+This project is licensed under the Apache License 2.0. See [LICENSE](LICENSE).

tests/test_readme_requirements.py

@@ -0,0 +1,24 @@
+# SPDX-FileCopyrightText: Copyright (c) 2026, Redis
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from pathlib import Path
+
+
+def test_readme_covers_nat_third_party_plugin_requirements() -> None:
+    readme = (Path(__file__).resolve().parents[1] / "README.md").read_text(encoding="utf-8")
+
+    required_snippets = [
+        "uv add nemo-agent-toolkit-redis",
+        "pip install nemo-agent-toolkit-redis",
+        "uv run nat info components",
+        "NeMo Agent Toolkit `>=1.6.0,<2.0.0`",
+        "https://github.com/redis-developer/nemo-agent-toolkit-redis/issues",
+        "https://github.com/NVIDIA/NeMo-Agent-Toolkit/issues",
+        "Apache License 2.0",
+    ]
+
+    missing = [snippet for snippet in required_snippets if snippet not in readme]
+
+    assert not missing, f"README.md is missing required third-party plugin guidance: {missing}"