Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
duckinator committed Mar 22, 2024
1 parent ad0c8fd commit ab30659
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,8 @@ Homf is a tool for downloading artifacts from online services, like a ZipApp fro

Documentation: <https://homf.readthedocs.io/>

If you have [pipx](https://pipx.pypa.io/) installed, it is recommended to
use `pipx run homf ...` instead. You can use a shell alias, such as
`alias homf='pipx run homf'`, to avoid having to remember this.
The recommended way to install Homf is via [pipx](https://pipx.pypa.io/).
If you have pipx installed, you can install Homf via `pipx install homf`.

The basic syntax is `homf SOURCE [OPTIONS] PACKAGE RELEASE`. `SOURCE` is one of `github` or `pypi`.
For GitHub, `PACKAGE` is the repository and `RELEASE` is the tag used by GitHub Releases.
Expand Down

0 comments on commit ab30659

Please sign in to comment.