diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..349c2d8 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023-2025 Henrik Hautakoski + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..6a21d42 --- /dev/null +++ b/README.md @@ -0,0 +1,57 @@ +# Pinger + +**Pinger** is a lightweight, high-performance network utility written in Go. +It enables users to send ICMP echo requests (pings) to specified hosts, facilitating network diagnostics and monitoring. + +## Features + +* Send ICMP echo requests to specified hosts. +* Measure round-trip time (RTT) for each ping. +* Support for both IPv4 and IPv6 addresses. +* Configurable number of ping attempts and intervals. +* Lightweight and efficient, suitable for scripting and automation. + +## Installation + +### Prerequisites + +* Go (version 1.20 or later) installed on your system. +* make + +### Steps + +1. Clone the repository: + +```bash +git clone https://github.com/pnx/pinger.git +cd pinger +``` + +2. Build the application: + +```bash +make +``` + +## Usage + +See `./pinger -h` + +### Example + +```bash +./pinger --udp -t 30s example.com +``` + +This command sends UDP echo requests to example.com, stopping after 30 seconds + +```bash +./pinger -c 8 -i 1s example.com +``` + +This command sends 8 ICMP echo requests to example.com, with a 1-second interval between pings. +NOTE: this requires root privileges + +## License + +This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.