Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
spencerwooo committed Nov 12, 2022
1 parent 05bf830 commit 8dfa470
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 8 deletions.
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,26 @@
## Install

You need at least Python 3.7.
You need at least Python 3.7. We recommend installing with `pipx`.

```bash
python -m pip install bitsrun
python3 -m pip install --user pipx
python3 -m pipx ensurepath
```

After which, install `bitsrun` with `pipx`.

```bash
pipx install bitsrun
```

## Usage

### CLI

```bash
python -m bitsrun login -u|--username xxxx -p|--password xxxx
python -m bitsrun logout -u|--username xxxx -p|--password xxxx
bitsrun login -u|--username xxxx -p|--password xxxx
bitsrun logout -u|--username xxxx -p|--password xxxx
```

Optional params:
Expand All @@ -37,8 +44,8 @@ Either `/etc/bit-user.json` or `~/.config/bit-user.json`:
```

```bash
python -m bitsrun login
python -m bitsrun logout
bitsrun login
bitsrun logout
```

### Raycast script (macOS)
Expand Down
2 changes: 1 addition & 1 deletion scripts/login-10.0.0.55.sh
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@
# @raycast.author Spencer Woo
# @raycast.authorURL https://spencerwoo.com

/usr/bin/python3 -m 10_0_0_55 login --no-color
bitsrun login --no-color
2 changes: 1 addition & 1 deletion scripts/logout-10.0.0.55.sh
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@
# @raycast.author Spencer Woo
# @raycast.authorURL https://spencerwoo.com

/usr/bin/python3 -m 10_0_0_55 logout --no-color
bitsrun logout --no-color

0 comments on commit 8dfa470

Please sign in to comment.