You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+26-27Lines changed: 26 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,50 +30,49 @@ You can also replace `hub` with `ingest` in any GitHub URL to access the corresp
30
30
31
31
- Python 3.7+
32
32
33
-
## 📦 Installation
33
+
###📦 Installation
34
34
35
-
```bash
35
+
Gitingest is available on [PyPI](https://pypi.org/project/gitingest/).
36
+
You can install it using `pip`:
37
+
38
+
```bash
36
39
pip install gitingest
37
40
```
38
41
39
-
## 🧩 Browser Extension Usage
40
-
41
-
<!-- markdownlint-disable MD033 -->
42
-
<ahref="https://chromewebstore.google.com/detail/adfjahbijlkjfoicpjkhjicpjpjfaood"target="_blank"title="Get Gitingest Extension from Chrome Web Store"><imgheight="48"src="https://github.com/user-attachments/assets/20a6e44b-fd46-4e6c-8ea6-aad436035753"alt="Available in the Chrome Web Store" /></a>
43
-
<ahref="https://addons.mozilla.org/firefox/addon/gitingest"target="_blank"title="Get Gitingest Extension from Firefox Add-ons"><imgheight="48"src="https://github.com/user-attachments/assets/c0e99e6b-97cf-4af2-9737-099db7d3538b"alt="Get The Add-on for Firefox" /></a>
44
-
<ahref="https://microsoftedge.microsoft.com/addons/detail/nfobhllgcekbmpifkjlopfdfdmljmipf"target="_blank"title="Get Gitingest Extension from Microsoft Edge Add-ons"><imgheight="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.
54
44
55
45
```bash
56
-
pip install gitingest
46
+
brew install pipx
47
+
apt install pipx
48
+
scoop install pipx
49
+
...
57
50
```
58
51
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:
64
53
65
54
```bash
66
-
brew install pipx
67
55
pipx ensurepath
68
56
```
69
57
70
-
Finally, install `gitingest`:
71
-
72
58
```bash
59
+
# install gitingest
73
60
pipx install gitingest
74
61
```
75
62
76
-
### Usage
63
+
## 🧩 Browser Extension Usage
64
+
65
+
<!-- markdownlint-disable MD033 -->
66
+
<ahref="https://chromewebstore.google.com/detail/adfjahbijlkjfoicpjkhjicpjpjfaood"target="_blank"title="Get Gitingest Extension from Chrome Web Store"><imgheight="48"src="https://github.com/user-attachments/assets/20a6e44b-fd46-4e6c-8ea6-aad436035753"alt="Available in the Chrome Web Store" /></a>
67
+
<ahref="https://addons.mozilla.org/firefox/addon/gitingest"target="_blank"title="Get Gitingest Extension from Firefox Add-ons"><imgheight="48"src="https://github.com/user-attachments/assets/c0e99e6b-97cf-4af2-9737-099db7d3538b"alt="Get The Add-on for Firefox" /></a>
68
+
<ahref="https://microsoftedge.microsoft.com/addons/detail/nfobhllgcekbmpifkjlopfdfdmljmipf"target="_blank"title="Get Gitingest Extension from Microsoft Edge Add-ons"><imgheight="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
77
76
78
77
The `gitingest` command line tool allows you to analyze codebases and create a text dump of their contents.
0 commit comments