From 4eed03d8e7467e4aed909207ff998b67bd595c59 Mon Sep 17 00:00:00 2001 From: Charlie Marsh Date: Tue, 7 Nov 2023 19:01:33 -0800 Subject: [PATCH] Update README limitations (#363) --- README.md | 27 ++++++++++++++++----------- 1 file changed, 16 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 23a26a488..c0ae62cb8 100644 --- a/README.md +++ b/README.md @@ -31,9 +31,6 @@ with a minimal barrier to adoption. Try it today in lieu of `pip` and `pip-tools Puffin does not yet support: -- Source distributions -- VCS dependencies -- URL dependencies - Windows - ... @@ -58,18 +55,26 @@ cargo run -p puffin-cli -- pip-sync requirements.txt For more, see `cargo run -p puffin-cli -- --help`: ```text -Usage: puffin-cli +Usage: puffin [OPTIONS] Commands: - compile Compile a `requirements.in` file to a `requirements.txt` file - sync Sync dependencies from a `requirements.txt` file - clean Clear the cache - freeze Enumerate the installed packages in the current environment - help Print this message or the help of the given subcommand(s) + pip-compile Compile a `requirements.in` file to a `requirements.txt` file + pip-sync Sync dependencies from a `requirements.txt` file + pip-uninstall Uninstall packages from the current environment + clean Clear the cache + freeze Enumerate the installed packages in the current environment + venv Create a virtual environment + add Add a dependency to the workspace + remove Remove a dependency from the workspace + help Print this message or the help of the given subcommand(s) Options: - -h, --help Print help - -V, --version Print version + -q, --quiet Do not print any output + -v, --verbose Use verbose output + -n, --no-cache Avoid reading from or writing to the cache + --cache-dir Path to the cache directory [env: PUFFIN_CACHE_DIR=] + -h, --help Print help + -V, --version Print version ``` ## License