Skip to content

Commit c995d51

Browse files
committed
docs: update README
1 parent fdb6001 commit c995d51

File tree

3 files changed

+24
-8
lines changed

3 files changed

+24
-8
lines changed

.assets/demo.gif

588 KB
Loading

.assets/logo.png

23.3 KB
Loading

README.md

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,17 @@
1-
<h1 align="center">mailtm</h1>
2-
<p align="center">CLI client for <a href="https://mail.tm">Mail.tm</a> disposable mail service</p>
1+
<div align="center">
2+
<img width="600px" src="./.assets/logo.png" />
33

4-
<p align="center">
4+
<p>CLI client for <a href="https://mail.tm">Mail.tm</a> disposable mail service</p>
5+
6+
<p>
57
<a href="https://github.com/abgeo/mailtm">
68
<img alt="GitHub go.mod Go version of a Go module" src="https://img.shields.io/github/go-mod/go-version/abgeo/mailtm.svg">
79
</a>
810
<a href="https://github.com/abgeo/mailtm/actions/workflows/ci.yaml">
9-
<img alt="Lint" src="https://github.com/abgeo/mailtm/actions/workflows/ci.yaml/badge.svg">
11+
<img alt="CI" src="https://github.com/abgeo/mailtm/actions/workflows/ci.yaml/badge.svg">
12+
</a>
13+
<a href="https://github.com/abgeo/mailtm/actions/workflows/cd.yaml">
14+
<img alt="CD" src="https://github.com/abgeo/mailtm/actions/workflows/cd.yaml/badge.svg">
1015
</a>
1116
<a href="https://app.fossa.com/projects/custom%2B30026%2Fgithub.com%2FABGEO%2Fmailtm?ref=badge_shield" alt="FOSSA Status">
1217
<img src="https://app.fossa.com/api/projects/custom%2B30026%2Fgithub.com%2FABGEO%2Fmailtm.svg?type=shield"/>
@@ -28,14 +33,25 @@
2833
</a>
2934
</p>
3035

31-
## Requirements
32-
33-
- `Go (>=1.19)`
36+
<p><img width="1000" src="./.assets/demo.gif" /></p>
37+
</div>
3438

3539
## Installation
3640

41+
## Binary
42+
43+
Go to the [Releases](https://github.com/ABGEO/mailtm/releases) page and download the version suitable for your OS.
44+
45+
## Source
46+
47+
```shell
48+
$ go install github.com/abgeo/mailtm@latest
49+
```
50+
3751
## Usage
3852

53+
Get available commands by running `mailtm --help`
54+
3955
## Authors
4056

4157
- [Temuri Takalandze](https://abgeo.dev) - *Maintainer*
@@ -45,4 +61,4 @@
4561
Copyright (c) 2022 [Temuri Takalandze](https://abgeo.dev).
4662
Released under the [GPL-3.0](LICENSE) license.
4763

48-
[![FOSSA Status](https://app.fossa.com/api/projects/custom%2B30026%2Fgithub.com%2FABGEO%2Fmailtm.svg?type=large)](https://app.fossa.com/projects/custom%2B30026%2Fgithub.com%2FABGEO%2Fmailtm?ref=badge_large)
64+
[![FOSSA Status](https://app.fossa.com/api/projects/custom%2B30026%2Fgithub.com%2FABGEO%2Fmailtm.svg?type=large)](https://app.fossa.com/projects/custom%2B30026%2Fgithub.com%2FABGEO%2Fmailtm?ref=badge_large)

0 commit comments

Comments
 (0)