diff --git a/README.md b/README.md index e69de29..271c2de 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,59 @@ +# LOIC + +A DDOS tool that can be used to attack Kubernetes services and arbitrary URLs. + +## Installation + +Instructions on how to install and set up LOIC. + +```bash +# Clone the repository +git clone https://forgejo.edf-bootstrap.cx.fg1.ffm.osc.live/Daniel.Sy/loic-go.git + +# Navigate to the project directory +cd loic-go + +# Install dependencies +go mod tidy +``` + +## Building with Go + +Instructions on how to build and start LOIC using Go. + +```bash +# Build LOIC +go build -o loic + +# Start LOIC +./loic start +``` + +## Usage + +Instructions on how to LOIC. + +```bash +# Start an attack +./loic start --target http://example.com -c 10 -d 1m -r 30s + +# Get the status of LOIC +./loic status + +# Start the Web UI +./loic web + +# Stop LOIC +./loic stop +``` + +## Contributing + +Guidelines for contributing to the project. + +1. Fork the repository. +2. Create a new branch (`git checkout -b feature-branch`). +3. Make your changes. +4. Commit your changes (`git commit -m 'Add some feature'`). +5. Push to the branch (`git push origin feature-branch`). +6. Open a pull request.