diff --git a/README.rst b/README.rst index cfcafae..2ffba99 100644 --- a/README.rst +++ b/README.rst @@ -39,9 +39,18 @@ Features - Sanitize/Validate a string as a: - file name - file path -- file name/path argument validator/sanitizer for ``argparse`` and ``click`` +- Sanitize will do: + - Remove invalid characters for a target platform + - Replace reserved names for a target platform + - Normalize + - Remove unprintable characters +- Argument validator/sanitizer for ``argparse`` and ``click`` - Multi platform support: - - sanitize/validate file names/paths for a specific platform (``Linux``/``Windows``/``macOS``/``POSIX``) or ``universal`` (platform independent) + - ``Linux`` + - ``Windows`` + - ``macOS`` + - ``POSIX`` + - ``universal`` (platform independent) - Multibyte character support Examples @@ -110,9 +119,9 @@ Validate a filename :Output: .. code-block:: - [PV1100] invalid characters found: target-platform=universal, description=invalids=('/'), value='fi:l*e/p"a?t>h|.t