Skip to content

Commit

Permalink
update readme after command name change
Browse files Browse the repository at this point in the history
  • Loading branch information
Esgrove committed Oct 28, 2024
1 parent d69ffe4 commit 8f7c23c
Showing 1 changed file with 21 additions and 2 deletions.
23 changes: 21 additions & 2 deletions python-pyo3/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,12 @@ See the [root readme](../README.md) for more general information.

## Usage

Uses `pvault` command name to avoid conflict with the previous Python version and the Rust version.

```console
Usage: vault [OPTIONS] COMMAND [ARGS]...
Usage: pvault [OPTIONS] COMMAND [ARGS]...

Nitor Vault CLI, see https://github.com/nitorcreations/vault for usage examples
Nitor Vault CLI, see https://github.com/nitorcreations/vault for usage examples

╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --bucket -b TEXT Override the bucket name [env var: VAULT_BUCKET] │
Expand Down Expand Up @@ -40,6 +42,23 @@ Nitor Vault CLI, see https://github.com/nitorcreations/vault for usage examples
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
```

## Install

Install command globally using pip. From repo root:

```shell
cd python-pyo3
pip install .
```

Check the command is found in path.
If you ran the install command inside a virtual env,
it will only be installed to the venv.

```shell
which -a pvault
```

## Development

Uses:
Expand Down

0 comments on commit 8f7c23c

Please sign in to comment.