Skip to content

Commit 25dc2cf

Browse files
committed
Added a few lines on use cases to the README
1 parent 130e3d0 commit 25dc2cf

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

+15-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,16 @@ The Octocat getting X-Rayed | [![Build Workflows](https://github.com/kulkansecu
66
![Gitxray Logo](https://kulkansecurity.github.io/gitxray/images/logo_gitxray.png "Gitxray Logo") | ![Gitxray Console](https://kulkansecurity.github.io/gitxray/images/console_gitxray.png "Gitxray Console")
77
<div style="clear: both;"></div>
88

9-
# Use-cases and documentation
9+
# Use cases
10+
Gitxray can be used to, for example:
11+
- Find sensitive information in contributor profiles disclosed by accident within, for example, Armored PGP Keys, or Key Names.
12+
- Identify threat actors in a Repository. You may spot co-owned or shared accounts, as well as inspect public events to spot fake Stargazers.
13+
- Identify fake or infected Repositories. It can detect tampered commit dates as well as, for example, Release assets updated post-release.
14+
- And a lot more!
15+
16+
Please refer to the Documentation for additional use-cases and introductory information.
17+
18+
# Documentation
1019
- [https://kulkansecurity.github.io/gitxray/](https://kulkansecurity.github.io/gitxray/)
1120
- [https://www.gitxray.com/](https://www.gitxray.com/)
1221

@@ -27,6 +36,11 @@ Once installed, simply run gitxray from your command line by typing:
2736
gitxray -h
2837
```
2938

39+
## Run your first full X-Ray
40+
```bash
41+
gitxray -o https://github.com/kulkansecurity -v
42+
```
43+
3044
## Installing from source
3145

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

0 commit comments

Comments
 (0)