docs: readme

This commit is contained in:
Maas Lalani
2023-06-21 15:11:55 -04:00
parent d550dfa63c
commit 85b29ab02a
2 changed files with 72 additions and 8 deletions

View File

@@ -1,7 +1,23 @@
# Pop
<p>
<a href="https://github.com/charmbracelet/vhs/releases"><img src="https://img.shields.io/github/release/charmbracelet/vhs.svg" alt="Latest Release"></a>
<a href="https://pkg.go.dev/github.com/charmbracelet/vhs?tab=doc"><img src="https://godoc.org/github.com/golang/gddo?status.svg" alt="Go Docs"></a>
<a href="https://github.com/charmbracelet/vhs/actions"><img src="https://github.com/charmbracelet/vhs/workflows/build/badge.svg" alt="Build Status"></a>
</p>
Send emails from your terminal.
<img width="600" src="https://vhs.charm.sh/vhs-5Ci4SK0PHtyZGoccEOvUEB.gif" alt="pop mail client">
## Text-based User Interface
Launch the TUI
```bash
pop
```
## Command Line Interface
```bash
@@ -12,14 +28,6 @@ pop < message.md \
--attach invoice.pdf
```
## Text-based User Interface
Launch the TUI
```bash
pop
```
## Installation
Use a package manager: