diff --git a/README.md b/README.md index b20522bf8..8df5c447f 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,17 @@ # NeMo Guardrails -[![Tests](https://img.shields.io/badge/Tests-passing-green)](#) -[![License](https://img.shields.io/badge/License-Apache%202.0-brightgreen.svg)](https://github.com/NVIDIA/NeMo-Guardrails/blob/main/LICENSE.md) -[![PyPI version](https://badge.fury.io/py/nemoguardrails.svg)](https://badge.fury.io/py/nemoguardrails) -[![Python 3.8+](https://img.shields.io/badge/python-3.8%2B-green)](https://www.python.org/downloads/) +[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) +[![PyPI](https://img.shields.io/pypi/v/nemoguardrails)](https://pypi.org/project/nemoguardrails) +[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/nemoguardrails)](https://pypi.org/project/nemoguardrails) +[![Tests/Linux](https://img.shields.io/github/actions/workflow/status/NVIDIA/NeMo-Guardrails/pr-tests.yml?logo=github&label=Tests%2FLinux)](https://github.com/NVIDIA/NeMo-Guardrails/actions/workflows/pr-tests.yml) +[![Tests/Windows](https://img.shields.io/github/actions/workflow/status/NVIDIA/NeMo-Guardrails/full-tests.yml?logo=github&label=Tests%2FWindows)](https://github.com/NVIDIA/NeMo-Guardrails/actions/workflows/full-tests.yml) +[![Tests/macOS](https://img.shields.io/github/actions/workflow/status/NVIDIA/NeMo-Guardrails/full-tests.yml?logo=github&label=Tests%2FmacOS)](https://github.com/NVIDIA/NeMo-Guardrails/actions/workflows/full-tests.yml) +[![Lint](https://img.shields.io/github/actions/workflow/status/NVIDIA/NeMo-Guardrails/lint.yml?logo=github&label=Lint)](https://github.com/NVIDIA/NeMo-Guardrails/actions/workflows/lint.yml) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) -[![arXiv](https://img.shields.io/badge/arXiv-2310.10501-b31b1b.svg)](https://arxiv.org/abs/2310.10501) +[![Documentation](https://img.shields.io/badge/docs-nvidia.com-blue.svg)](https://docs.nvidia.com/nemo/guardrails) +[![arXiv](https://img.shields.io/badge/cs.CL-arXiv%3A2310.10501-b31b1b.svg)](https://arxiv.org/abs/2310.10501) +[![Downloads](https://static.pepy.tech/badge/nemoguardrails)](https://pepy.tech/project/nemoguardrails) +[![Downloads](https://static.pepy.tech/badge/nemoguardrails/month)](https://pepy.tech/project/nemoguardrails) > **LATEST RELEASE / DEVELOPMENT VERSION**: The [main](https://github.com/NVIDIA/NeMo-Guardrails/tree/main) branch tracks the latest released beta version: [0.19.0](https://github.com/NVIDIA/NeMo-Guardrails/tree/v0.19.0). For the latest development version, checkout the [develop](https://github.com/NVIDIA/NeMo-Guardrails/tree/develop) branch.