Skip to content

Commit cb1c48e

Browse files
committed
Replicating the same Intro structure as in the github repo
1 parent 726532c commit cb1c48e

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

docs/index.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
1-
# Welcome to Gitxray
2-
3-
![alt text](images/logo_gitxray.png){ width="300", align="left" }
4-
1+
# Welcome to Gitxray
52
Gitxray (short for Git X-Ray) is a multifaceted security tool designed for use on GitHub repositories. It can serve many purposes, including OSINT and Forensics. `gitxray` leverages public GitHub REST APIs to gather information that would otherwise be very time-consuming to obtain manually. Additionally, it seeks out information in unconventional places.
63

4+
The Octocat getting X-Rayed | [![Build Workflows](https://github.com/kulkansecurity/gitxray/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/kulkansecurity/gitxray) [![Latest Version in PIP](https://img.shields.io/pypi/v/gitxray.svg)](https://pypi.org/project/gitxray) [![Python Versions](https://img.shields.io/pypi/pyversions/gitxray.svg)](https://pypi.org/project/gitxray) [![License](https://img.shields.io/pypi/l/gitxray.svg)](https://github.com/kulkansecurity/gitxray/blob/main/LICENSE)
5+
--- | ---
6+
![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")
7+
<div style="clear: both;"></div>
8+
9+
# Getting started
710
* [Installing Gitxray](installing.md)
811
* [Awesome Features](awesome_features.md) &#128171;
912
* [More Features](more_features.md) &#129470;
1013

11-
<p>&nbsp;</p>
12-
1314
## Rate Limits and the GitHub API
1415

1516
Gitxray gracefully handles Rate Limits and can work out of the box without a GitHub API key, _but_ you'll likely hit RateLimits pretty fast. This is detailed by GitHub in their [documentation here](https://docs.github.com/en/rest/using-the-rest-api/rate-limits-for-the-rest-api?apiVersion=2022-11-28#primary-rate-limit-for-unauthenticated-users). A simple read-only token created for PUBLIC repositories will however help you increase those restrictions considerably. If you're not in a hurry or can leave `gitxray` running you'll be able to use its full capacity, as it pauses execution while waiting for the limits to lift.

0 commit comments

Comments
 (0)