diff --git a/.gitignore b/.gitignore index 4467010..777e674 100644 --- a/.gitignore +++ b/.gitignore @@ -25,3 +25,4 @@ go.work .mypy_cache/ .idea dist/ +bin/ diff --git a/README.md b/README.md index 29c54ef..c7032a2 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,18 @@ -# Updo - Website Monitoring Tool +
+ +# 🐤 Updo - Website Monitoring Tool + +

+ Updo demo +

Updo is a command-line tool for monitoring website uptime and performance. It provides real-time metrics on website status, response time, SSL certificate expiry, and more, with alert notifications. +![Language:Go](https://img.shields.io/static/v1?label=Language&message=Go&color=blue&style=flat-square) +![License:MIT](https://img.shields.io/static/v1?label=License&message=MIT&color=blue&style=flat-square) +[![Latest Release](https://img.shields.io/github/v/release/Owloops/updo?style=flat-square)](https://github.com/Owloops/updo/releases/latest) +
+ ## Features - Real-time monitoring of website uptime and performance @@ -15,6 +26,14 @@ Updo is a command-line tool for monitoring website uptime and performance. It pr Make sure you have Go [installed](https://go.dev/doc/install) on your system. +### Download executable binaries + +You can download executable binaries from the latest release page. + +> [![Latest Release](https://img.shields.io/github/v/release/Owloops/updo?style=flat-square)](https://github.com/Owloops/updo/releases/latest) + +### Build from source + You can install Updo by cloning the repository and building the binary: ```bash @@ -23,6 +42,12 @@ cd updo go build ``` +Another way to install it if you have go in your machine just: + +```sh +GOBIN="absolute_path_where_you_want_binaries_to_be_installed" go install github.com/sheepla/pingu@latest +``` + ## Usage Run Updo using the following command: diff --git a/images/demo.png b/images/demo.png new file mode 100644 index 0000000..6d8cb23 Binary files /dev/null and b/images/demo.png differ diff --git a/updo b/updo deleted file mode 100755 index 91414bf..0000000 Binary files a/updo and /dev/null differ