initial commit

README.md

@@ -0,0 +1,43 @@
+# YPS - Yggdrasil Port Scanner
+
+![Linux](https://github.com/yggverse/yps/actions/workflows/linux.yml/badge.svg)
+[![Dependencies](https://deps.rs/repo/github/yggverse/yps/status.svg)](https://deps.rs/repo/github/yggverse/yps)
+[![crates.io](https://img.shields.io/crates/v/yps)](https://crates.io/crates/yps)
+
+A simple crawler tool to find open ports for specific services,
+such as web servers or Bitcoin nodes, to connect with [Yggdrasil](https://yggdrasil-network.github.io/).
+
+## Install
+
+* `git clone https://github.com/yggverse/yps.git && cd yps`
+* `cargo build --release`
+* `sudo install target/release/yps /usr/local/bin/yps`
+
+## Usage
+
+``` bash
+sudo yps --tcp -p 80 -p 443
+```
+
+### Options
+
+``` bash
+-d, --debug
+        Print debug information
+-s, --socket <SOCKET>
+        Yggdrasil socket path (unix only) [default: /var/run/yggdrasil.sock]
+-p, --port <PORT>
+        Port(s) to scan
+-u, --udp <UDP>
+        Crawl UDP ports (requires `[host]:port` binding as the value)
+-t, --tcp
+        Crawl TCP ports
+-l, --latency <LATENCY>
+        Pause in seconds before make new request
+    --index-capacity <INDEX_CAPACITY>
+        Optimize memory usage by providing expecting index capacity, according to the current network size [default: 1000]
+-h, --help
+        Print help
+-V, --version
+        Print version
+```