Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
Signed-off-by: Tsuyoshi Hombashi <tsuyoshi.hombashi@gmail.com>
  • Loading branch information
thombashi committed Dec 30, 2024
1 parent 39e3ab5 commit 34d6170
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Installation: pip

pip install cleanpy

|Supported Python versions| |Supported Python implementations|
|Supported Python implementations| |Supported Python versions|

Installation: snap
--------------------------------------------
Expand Down Expand Up @@ -97,7 +97,9 @@ Command help
--------------------------------------------
::

usage: cleanpy [-h] [-V] [--list] [--follow-symlinks] [--dry-run] [-a] [--include-builds] [--include-envs] [--include-metadata] [--include-testing] [--exclude PATTERN] [--exclude-envs] [-i | -f] [-v | --debug | --quiet] DIR_PATH [DIR_PATH ...]
usage: cleanpy [-h] [-V] [--list] [--follow-symlinks] [--dry-run] [-a] [--include-builds] [--include-envs] [--include-metadata] [--include-testing] [--exclude PATTERN] [--exclude-envs] [-i | -f] [-v |
--debug | --quiet]
DIR_PATH [DIR_PATH ...]

cleanpy will remove cache files and temporary files under the DIR_PATH.

Expand All @@ -111,7 +113,7 @@ Command help
-V, --version show program's version number and exit
--list print target directories/files. this does not actually remove directories/files.
--follow-symlinks follow symlinks.
--dry-run do no harm.
--dry-run don't actually do anything.
-i, --interactive prompt on each file/directory delete.
-f, --force delete file/directory without prompt.
-v, --verbose shows the verbose output.
Expand Down Expand Up @@ -156,4 +158,4 @@ Python 3.9+

.. |Supported Python implementations| image:: https://img.shields.io/pypi/implementation/cleanpy.svg
:target: https://pypi.org/project/cleanpy
:alt: Supported Python implementations
:alt: Supported Python implementations

0 comments on commit 34d6170

Please sign in to comment.