Skip to content

Commit

Permalink
fix: readme image
Browse files Browse the repository at this point in the history
  • Loading branch information
pgagnidze committed Dec 26, 2023
1 parent 22b0ac3 commit 6888498
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 1 deletion.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,4 @@ go.work
.mypy_cache/
.idea
dist/
bin/
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,18 @@
# Updo - Website Monitoring Tool
<div align="center">

# 🐤 Updo - Website Monitoring Tool

<p align="center">
<img src="images/demo.png" alt="Updo demo" width="600"/>
</p>

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)
</div>

## Features

- Real-time monitoring of website uptime and performance
Expand All @@ -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
Expand All @@ -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:
Expand Down
Binary file added images/demo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed updo
Binary file not shown.

0 comments on commit 6888498

Please sign in to comment.