From 43e231d8dce4a9f12ecbde1be1a8092406d2aaa9 Mon Sep 17 00:00:00 2001 From: Educg550 Date: Fri, 8 Aug 2025 14:56:25 -0300 Subject: [PATCH] docs: add cli disclaimer --- README.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.rst b/README.rst index de3f0ad..34eed3e 100644 --- a/README.rst +++ b/README.rst @@ -36,6 +36,10 @@ We also recommend that implementers read the `NIST SP 800-63-3: Digital Authentication Guideline `_ for a high level overview of authentication best practices. +Disclaimer on Command-Line Interface (CLI) usage +-------------------------------------------------------- +PyOTP is **NOT** a command-line interface (CLI). If you are looking for a CLI tool, this is not the right project. PyOTP is a **library** intended for use by other applications that provide a user interface, such as `3ncrypt0rQR `_ or `pyotp_cli `_. While a CLI may be added in the future—see `Pull Request #159 `_—this is not the current focus of the project. + Quick overview of using One Time Passwords on your phone --------------------------------------------------------