summaryrefslogtreecommitdiff
path: root/cli/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'cli/README.md')
-rw-r--r--cli/README.md20
1 files changed, 14 insertions, 6 deletions
diff --git a/cli/README.md b/cli/README.md
index d7858404..cb5f9bc5 100644
--- a/cli/README.md
+++ b/cli/README.md
@@ -27,13 +27,13 @@ First, make sure you have `tor` installed. In Linux, install it through your pac
Then install OnionShare CLI:
-```
+```sh
pip install onionshare-cli
```
Then run it with:
-```
+```sh
onionshare-cli --help
```
@@ -43,25 +43,33 @@ You must have python3 and [poetry](https://python-poetry.org/) installed.
Install dependencies with poetry:
-```
+```sh
poetry install
```
To run from the source tree:
-```
+```sh
poetry run onionshare-cli
```
To run tests:
-```
+```sh
poetry run pytest -v ./tests
```
+## Build a wheel package
+
+```sh
+poetry build
+```
+
+This will create `dist/onionshare_cli-$VERSION-py3-none-any.whl`.
+
### Making a release
-Before making a release, make update the version in these places:
+Before making a release, update the version in these places:
- `pyproject.toml`
- `onionshare_cli/resources/version.txt`