Skip to content

Commit

Permalink
docs: update pipx install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
@daniel-makerx @achidlow
daniel-makerx authored and achidlow committed Jan 11, 2023
1 parent a4a13f8 commit e91a06a
Showing 1 changed file with 3 additions and 6 deletions.
9 changes: 3 additions & 6 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -134,12 +134,9 @@ AlgoKit can be installed using OS specific package managers, or using the python

2. Install using pipx

> **Note**
> This method is not yet working while we decide on what the PyPi package name will be.
- ~~Install AlgoKit: `pipx install algokit`~~
- ~~Update AlgoKit: `pipx upgrade algokit`~~
- ~~Remove AlgoKit: `pipx uninstall algokit`~~
- Install AlgoKit: `pipx install algokit-cli`
- Update AlgoKit: `pipx upgrade algokit-cli`
- Remove AlgoKit: `pipx uninstall algokit-cli`

3. [Verify installation](#verify-installation)

Expand Down

1 comment on commit e91a06a

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage

Coverage Report
FileStmtsMissCoverMissing
src/algokit
   __init__.py15753%6–13, 17–24, 32–34
   __main__.py220%1–3
src/algokit/cli
   completions.py103199%91
   doctor.py48394%140–142
   init.py1651690%57, 204–205, 236, 239–241, 252, 290, 327, 336–338, 341–346, 361
   sandbox.py84199%155
src/algokit/core
   bootstrap.py1331688%109, 129, 201, 204, 210–224
   click_extensions.py472057%40–43, 50, 56, 67–68, 73–74, 79–80, 91, 104–114
   conf.py31487%14, 18, 26, 28
   doctor.py54394%63–65
   log_handlers.py68987%44–45, 50–51, 63, 112–116, 125
   proc.py44198%95
   sandbox.py112794%86, 151, 167, 182–184, 199
   version_prompt.py70987%27–28, 33, 52–55, 66, 76, 105
TOTAL11159991% 

Tests Skipped Failures Errors Time
156 0 💤 0 ❌ 0 🔥 12.810s ⏱️

Please sign in to comment.