Verified Commit 1247460f authored by Jenny's avatar Jenny
Browse files

added readme

parent 9d26f661
......@@ -4,6 +4,7 @@ version = "1.0.0"
edition = "2018"
authors = ["Netali <me@netali.de>"]
repository = "https://gitlab.fem-net.de/netali/pixelspammer"
readme = "readme.md"
license = "AGPL-3.0-or-later"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
......
# pixelspammer
A simple, multithreaded pixelflut client to spam images in slices
## Usage
### Without installation
Just run it with cargo directly:
```
$ cargo run --release -- -h [IP:port] -i [/path/to/image.png] -s [number of slices] (-x [x-offset]) (-y [y-offset])
```
Or to get detailed help for the options:
```
$ cargo run --release -- --help
```
### With installation
Install it (and make sure that **~/.cargo/bin** is in your **PATH**):
```
$ cargo install --path .
```
And then run it:
```
$ pixelspammer -h [IP:port] -i [/path/to/image.png] -s [number of slices] (-x [x-offset]) (-y [y-offset])
```
Or to get detailed help for the options:
```
$ pixelspammer --help
```
\ No newline at end of file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment