Skip to content

Commit d36b3a0

Browse files
fix: adding missing suggested changes from #252 (#256)
Co-authored-by: Nicolas IRAGNE <nicoragne@hotmail.fr>
1 parent 320d650 commit d36b3a0

File tree

1 file changed

+26
-27
lines changed

1 file changed

+26
-27
lines changed

README.md

Lines changed: 26 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -30,50 +30,49 @@ You can also replace `hub` with `ingest` in any GitHub URL to access the corresp
3030

3131
- Python 3.7+
3232

33-
## 📦 Installation
33+
### 📦 Installation
3434

35-
``` bash
35+
Gitingest is available on [PyPI](https://pypi.org/project/gitingest/).
36+
You can install it using `pip`:
37+
38+
```bash
3639
pip install gitingest
3740
```
3841

39-
## 🧩 Browser Extension Usage
40-
41-
<!-- markdownlint-disable MD033 -->
42-
<a href="https://chromewebstore.google.com/detail/adfjahbijlkjfoicpjkhjicpjpjfaood" target="_blank" title="Get Gitingest Extension from Chrome Web Store"><img height="48" src="https://github.com/user-attachments/assets/20a6e44b-fd46-4e6c-8ea6-aad436035753" alt="Available in the Chrome Web Store" /></a>
43-
<a href="https://addons.mozilla.org/firefox/addon/gitingest" target="_blank" title="Get Gitingest Extension from Firefox Add-ons"><img height="48" src="https://github.com/user-attachments/assets/c0e99e6b-97cf-4af2-9737-099db7d3538b" alt="Get The Add-on for Firefox" /></a>
44-
<a href="https://microsoftedge.microsoft.com/addons/detail/nfobhllgcekbmpifkjlopfdfdmljmipf" target="_blank" title="Get Gitingest Extension from Microsoft Edge Add-ons"><img height="48" src="https://github.com/user-attachments/assets/204157eb-4cae-4c0e-b2cb-db514419fd9e" alt="Get from the Edge Add-ons" /></a>
45-
<!-- markdownlint-enable MD033 -->
46-
47-
The extension is open source at [lcandy2/gitingest-extension](https://github.com/lcandy2/gitingest-extension).
48-
49-
Issues and feature requests are welcome to the repo.
50-
51-
## 💡 Command line usage
52-
53-
### Installation: Non mac
42+
However, it might be a good idea to use `pipx` to install it.
43+
You can install `pipx` using your preferred package manager.
5444

5545
```bash
56-
pip install gitingest
46+
brew install pipx
47+
apt install pipx
48+
scoop install pipx
49+
...
5750
```
5851

59-
### Installation: Mac
60-
61-
99% of mac users use `brew` as a local package manger.
62-
If Python and pip have been installed with `brew`, it is recommended to stay in this ecosystem with `pipx`.
63-
**If `pipx` does not exist and you are using `brew`, first install the following:**
52+
If you are using pipx for the first time, run:
6453

6554
```bash
66-
brew install pipx
6755
pipx ensurepath
6856
```
6957

70-
Finally, install `gitingest`:
71-
7258
```bash
59+
# install gitingest
7360
pipx install gitingest
7461
```
7562

76-
### Usage
63+
## 🧩 Browser Extension Usage
64+
65+
<!-- markdownlint-disable MD033 -->
66+
<a href="https://chromewebstore.google.com/detail/adfjahbijlkjfoicpjkhjicpjpjfaood" target="_blank" title="Get Gitingest Extension from Chrome Web Store"><img height="48" src="https://github.com/user-attachments/assets/20a6e44b-fd46-4e6c-8ea6-aad436035753" alt="Available in the Chrome Web Store" /></a>
67+
<a href="https://addons.mozilla.org/firefox/addon/gitingest" target="_blank" title="Get Gitingest Extension from Firefox Add-ons"><img height="48" src="https://github.com/user-attachments/assets/c0e99e6b-97cf-4af2-9737-099db7d3538b" alt="Get The Add-on for Firefox" /></a>
68+
<a href="https://microsoftedge.microsoft.com/addons/detail/nfobhllgcekbmpifkjlopfdfdmljmipf" target="_blank" title="Get Gitingest Extension from Microsoft Edge Add-ons"><img height="48" src="https://github.com/user-attachments/assets/204157eb-4cae-4c0e-b2cb-db514419fd9e" alt="Get from the Edge Add-ons" /></a>
69+
<!-- markdownlint-enable MD033 -->
70+
71+
The extension is open source at [lcandy2/gitingest-extension](https://github.com/lcandy2/gitingest-extension).
72+
73+
Issues and feature requests are welcome to the repo.
74+
75+
## 💡 Command line usage
7776

7877
The `gitingest` command line tool allows you to analyze codebases and create a text dump of their contents.
7978

0 commit comments

Comments
 (0)