Skip to content

Commit

Permalink
readme improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
Esgrove committed Nov 11, 2024
1 parent 6ce848a commit 4b0d2ec
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions python-pyo3/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Python vault implementation using the Rust vault library.

See the [repo](https://github.com/NitorCreations/vault) for more general information.
See the [repo](https://github.com/NitorCreations/vault) root readme for more general information.

## Usage

Expand Down Expand Up @@ -42,7 +42,7 @@ Options:

## Install

### PyPI
### From PyPI

Use [pipx](https://github.com/pypa/pipx) or [uv](https://github.com/astral-sh/uv)
to install the Python vault package from [PyPI](https://pypi.org/project/nitor-vault/) globally in an isolated environment.
Expand All @@ -53,11 +53,13 @@ pipx install nitor-vault
uv tool install nitor-vault
```

### From Source
The command `vault` should now be available in path.

### From source

Build and install locally from source code using pip.
This requires a [Rust toolchain](https://rustup.rs/) to be able to build the Rust library.
From repo root:
From the repo root:

```shell
cd python-pyo3
Expand Down

0 comments on commit 4b0d2ec

Please sign in to comment.