-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
132 additions
and
0 deletions.
There are no files selected for viewing
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
# Contributing to NetWhisper | ||
|
||
Thank you for considering contributing to NetWhisper! We appreciate your interest in making our project better. | ||
|
||
## Getting Started | ||
|
||
- Make sure you have a GitHub account. | ||
- Fork the repository on GitHub. | ||
- Clone your forked repository: `git clone https://github.com/yourusername/netwhisper.git` | ||
- Navigate to the project directory: `cd netwhisper` | ||
|
||
## Creating Issues | ||
|
||
If you find a bug, have a question, or want to suggest a new feature, you can create an issue on GitHub: | ||
|
||
1. Go to the [Issues](https://github.com/yourusername/netwhisper/issues) section. | ||
2. Click the "New Issue" button. | ||
3. Provide a descriptive title and detailed description. | ||
|
||
## Making Changes | ||
|
||
1. Create a new branch for your feature or bug fix: | ||
```git checkout -b feature/my-feature``` | ||
|
||
2. Make your changes and commit them: | ||
```git commit -m "Add my feature"``` | ||
|
||
3. Push your changes to your fork: | ||
```git push origin feature/my-feature``` | ||
|
||
4. Open a pull request (PR): | ||
- Go to the Pull Requests section. | ||
- Click the "New Pull Request" button. | ||
- Select your branch and the main repository's main branch. | ||
- Provide a descriptive title and detailed description of your changes. | ||
|
||
## Code Style | ||
- Follow the existing code style and conventions. | ||
- Write clear and concise commit messages. | ||
- Keep your code clean and well-documented. | ||
|
||
### License | ||
By contributing to NetWhisper, you agree that your contributions will be licensed under the Apache License 2.0. | ||
|
||
### Questions and Feedback | ||
If you have any questions or need further assistance, feel free to reach out in the Issues section. | ||
|
||
### Thank you for your contribution! |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
<p align="center"><a href="https://github.com/3rr0r-505/NetWhisper"><img alt="" src="https://github.com/3rr0r-505/NetWhisper/blob/master/NetWhisper-cover.png?raw=true" width="100%"/></a></p> | ||
|
||
<p align="center"> | ||
<a href="https://www.python.org/"><img alt="" src="https://img.shields.io/badge/python-3.9%2B-brighten?logo=python&label=pyhton&color=blue"/></a> | ||
| ||
<a href="https://www.gnu.org/gnu/linux-and-gnu.en.html"><img alt="" src="https://img.shields.io/badge/OS-GNU%2FLINUX-brighten?logo=linux&label=OS&labelColor=grey&color=red"/></a> | ||
| ||
<a href="https://www.microsoft.com/en-us/windows?r=1"><img alt="" src="https://img.shields.io/badge/OS-Windows-brighten?logo=windows&label=OS&labelColor=grey&color=blue"/></a><br> | ||
</p> | ||
|
||
# Roadmap for NetWhisper | ||
|
||
### Introduction | ||
This document outlines the roadmap for NetWhisper, detailing our plans and goals for future development. | ||
|
||
### Current Status | ||
At present, NetWhisper is in it's initial release [v1.0.0]. | ||
|
||
## Short-Term Goals | ||
- Goal 1: | ||
- **Name:** UI Improvement | ||
- **Description:** Change the user input position to center and make that section symmetric. | ||
|
||
- Goal 2: | ||
- **Name:** Packet Count | ||
- **Description:** If there's nothing mentioned in the ```Packet Count``` section, then it should scan and generate output continuously. | ||
|
||
## Mid-Term Goals | ||
- Goal 1: | ||
- **Name:** Integration with IDS/IPS | ||
- **Description:** Integrate the packet sniffer with ```Intrusion Detection Systems (IDS)``` or ```Intrusion Prevention Systems (IPS)``` to enhance network security. | ||
|
||
- Goal 2: | ||
- **Name:** Advanced Packet Analysis | ||
- **Description:** Additional filters will be added to obtain a more precise output. | ||
|
||
## Long-Term Vision | ||
Our long-term vision for **NetWhisper** is to make it more versetile: | ||
- **Tools Integration:** Tools Integration: Adding ```Wi-Fi Deauthenticator``` to NetWhisper. | ||
- **Traffic Visualization:** Create ```Graphical Representations & Visualizations``` of network traffic trends, helping users understand network behavior more easily. | ||
- **Performance Optimization:** Continuously improve the software's performance to handle high volumes of network traffic efficiently. | ||
- **Cross-Platform Support:** Extend support for various operating systems and platforms to reach a broader user base. | ||
|
||
<!--## Upcoming Features | ||
- [Feature 1] | ||
- Description: [Provide a brief description of the feature] | ||
- [Feature 2] | ||
- Description: [Provide a brief description of the feature] | ||
... | ||
## Technical Improvements | ||
- [Technical improvement 1] | ||
- Description: [Provide a brief description of the improvement] | ||
- [Technical improvement 2] | ||
- Description: [Provide a brief description of the improvement] | ||
... | ||
## Bug Fixes | ||
- [Bug 1] | ||
- Description: [Provide a brief description of the bug] | ||
- Target Fix Date: [Target date] | ||
- [Bug 2] | ||
- Description: [Provide a brief description of the bug] | ||
- Target Fix Date: [Target date] | ||
... --> | ||
|
||
## Community Involvement | ||
We welcome community involvement in shaping the future of NetWhisper. If you'd like to contribute, please see our [Contribution Guidelines](https://github.com/3rr0r-505/NetWhisper/blob/master/CONTRIBUTING.md). | ||
|
||
## Contributions Welcome | ||
We encourage contributions from the community and value your input. If you have ideas or suggestions, please open an issue or submit a pull request. | ||
|
||
## Feedback | ||
We appreciate your feedback on our roadmap. If you have any comments or questions, please don't hesitate to reach out to us. | ||
|
||
## Conclusion | ||
Thank you for your interest in NetWhisper. We are excited about the future and look forward to working together to make it a success! | ||
|