Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mohdh34m authored Sep 8, 2024
1 parent 1748719 commit 11cdcda
Showing 1 changed file with 59 additions and 15 deletions.
74 changes: 59 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,68 @@
# TraceNinja
<div align="center">
<img src="https://i.postimg.cc/5tNbFcTx/banner.png" alt="traceNinja Logo"/>
<p>TraceNinja is a subdomain enumeration tool for Python that allows you to enumerate domains and gather information about them. And much much more on the future ^_^. It's currently under development.</p>

## Description
![GitHub License](https://img.shields.io/github/license/mohdh34m/TraceNinja?style=for-the-badge&logo=python&logoColor=00ffff&color=00ffff)
![PyPI - Version](https://img.shields.io/pypi/v/TraceNinja?style=for-the-badge&logo=python&logoColor=00ffff&color=00ffff)
![PyPI - Downloads](https://img.shields.io/pypi/dm/TraceNinja?style=for-the-badge&logo=python&logoColor=00ffff&color=00ffff)
![star](https://custom-icon-badges.demolab.com/github/stars/mohdh34m/TraceNinja?style=for-the-badge&logo=star&logoColor=00ffff&color=00ffff)
</div>

**TraceNinja** is a subdomain enumeration tool for Python that allows you to enumerate domains and gather information about them. And much much more on the future ^_^. It's currently under development.
---

## Development Status
## 🚀 Features

This project is in its early stages, and you might encounter limited functionality or potential bugs.
- 🌐 **Cross-Platform**
- 🔍 **Real-time**
-**Fast and efficient**
- 🛠️ **Easy**

## Contributing
## 🖥️ Installation

To get started with `traceNinja`, you can install it via pip:

```bash
pip install TraceNinja
```
Alternatively, clone the repository and install it manually:
```bash
git clone https://github.com/mohdh34m/TraceNinja.git
cd TraceNinja
pip install -r requirements.txt
```
## 📖 Usage

Here’s a quick example of how to use traceNinja:
```bash
TraceNinja -d example.com
```
For a complete list of options, run:
```bash
TraceNinja -h
```

## 🤝 Contributing

Contributions are welcome! Please check out the contributing guidelines to get started.

1. **Fork the repository.**
2. **Create your feature branch: git checkout -b feature/YourFeature.**
3. **Commit your changes: git commit -m 'Add YourFeature'.**
4. **Push to the branch: git push origin feature/YourFeature.**
5. **Open a pull request.**

## 💖 Support
If you find this project useful, please consider supporting its development:

- **⭐️ Star this repository**


[![Sponsor with Github](https://custom-icon-badges.demolab.com/badge/-Sponsor-ea4aaa?style=for-the-badge&logo=heart&logoColor=white)](https://github.com/sponsors/mohdh34m "Sponsor me on GitHub")
[![Buy me a coffee](https://custom-icon-badges.demolab.com/badge/-Buy_me_a_coffee-FF5E5B?style=for-the-badge&logo=kofi&logoColor=white&color=00ffff)](https://ko-fi.com/mohdh34m "Buy me a coffee")

## 📄 License
**TraceNinja** is released under the [MIT License](https://github.com/mohdh34m/MDenum/tree/master?tab=MIT-1-ov-file).

here's a guide for contributing:

1. **Fork the repository:** Create a copy of the project on your GitHub account.
2. **Create a branch:** This allows you to make changes without affecting the main project codebase. Use a descriptive branch name (e.g., `git checkout -b feature/your-feature`).
3. **Make your changes:** Implement your desired modifications and write clean, well-commented code.
4. **Commit your changes:** Use descriptive commit messages (`git commit -m 'Added feature for X'`).
5. **Push to your branch:** Share your work with the main repository (`git push origin feature/your-feature`).
6. **Open a pull request:** This formally suggests your changes be integrated into the project.

## License

**TraceNinja** is distributed under the **MIT** license. Please look at the LICENSE: [Here](https://github.com/mohdh34m/MDenum/tree/master?tab=MIT-1-ov-file).

0 comments on commit 11cdcda

Please sign in to comment.