Skip to content

[docs] Docs #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Edgardo-Ramirez-Canales wants to merge 1 commit into
base: main
Choose a base branch
from
+32 −0
Open

[docs] Docs #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,4 +79,36 @@ Do NOT, under any circumstances, use any material in this repository maliciously

Cybercrime is cringe.

## Contributing

We welcome contributions to this project! If you have suggestions, improvements, or bug fixes, please feel free to submit a pull request or open an issue.

### How to Contribute
1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them with clear messages.
4. Push your changes to your forked repository.
5. Submit a pull request to the main repository.

### Code of Conduct
Please adhere to our code of conduct in all interactions related to the project.

## Installation Instructions

To install this project, clone the repository and install the required dependencies using the following commands:

```bash
git clone https://github.com/bikini/exploitarium.git
cd exploitarium
pip install -r requirements.txt
```

## Usage Examples

To run the proof of concept scripts, use the following command:

```bash
python poc.py
```

Make sure to replace `poc.py` with the actual script you want to run. Refer to the individual PoC README files for specific usage instructions.