Skip to content

Commit 047d434

Browse files
committed
Clarifications on how to install and run gitxray
1 parent 5e1088f commit 047d434

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,22 @@ Available at: https://www.gitxray.com/
1212

1313
# Installing and running Gitxray
1414

15+
gitxray was written with no use of external package dependencies other than the `requests` library.
16+
17+
## PyPI (PIP) Way
18+
1519
`gitxray` is on PyPI and can be installed with:
1620

1721
```bash
1822
pip install gitxray
1923
```
2024

21-
It was written with no use of external dependencies other than the `requests` library.
25+
Once installed, simply run gitxray from your command line by typing:
26+
```bash
27+
gitxray -h
28+
```
29+
30+
## Installing from source
2231

2332
You may also run `gitxray` directly by cloning or downloading its GitHub repository and running.
2433

0 commit comments

Comments
 (0)