Skip to content

Commit 3eebf69

Browse files
author
Irsyad
committed
Lead README install with pip install codebread (now live on PyPI)
1 parent eece48e commit 3eebf69

1 file changed

Lines changed: 10 additions & 7 deletions

File tree

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -60,27 +60,30 @@ That's it. Clone it, run it, nothing to compile.
6060
## Install
6161

6262
```bash
63-
# option A: install the CLI
64-
pip install .
65-
66-
# option B: don't install anything, just run it
67-
python codebread.py --path /path/to/project
63+
pip install codebread
6864
```
6965

7066
Optional extra (better `.gitignore` matching while scanning):
7167

7268
```bash
73-
pip install .[full] # adds pathspec
69+
pip install codebread[full] # adds pathspec
7470
```
7571

7672
Requires **Python 3.9+**. Nothing else.
7773

74+
Prefer running from source instead (e.g. to contribute)?
75+
76+
```bash
77+
git clone https://github.com/honow48-tech/CodeBread.git
78+
cd CodeBread
79+
pip install . # or: python codebread.py --path /path/to/project
80+
```
81+
7882
## Use
7983

8084
```bash
8185
codebread --path /path/to/project # scan + open the UI in your browser
8286
codebread # prompts for the path
83-
python codebread.py --path . # uninstalled, same thing
8487
```
8588

8689
That's the whole quick start: point it at a folder, a browser tab opens with

0 commit comments

Comments
 (0)