docs: readme

This commit is contained in:
Maas Lalani 2023-06-21 15:11:55 -04:00
parent d550dfa63c
commit 85b29ab02a
No known key found for this signature in database
GPG key ID: 5A6ED5CBF1A0A000
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:

56
demo.tape Normal file
View file

@ -0,0 +1,56 @@
Output demo.gif
Set FontSize 25
Set Padding 50
Set Width 800
Set Height 800
Hide
Type "export RESEND_API_KEY=$(pass RESEND_API_KEY)"
Enter
Sleep 1
Ctrl+L
Show
Type "pop"
Enter
Sleep 1
Type "pop@lalani.dev"
Sleep 0.5
Tab
Sleep 1
Type "maas@charm.sh"
Sleep 0.5
Tab
Sleep 1
Type "Pop"
Sleep 0.5
Tab
Sleep 1
Type "# Welcome to Pop."
Sleep 0.5
Enter 2
Sleep 0.5
Type "Send **emails** from the _terminal_."
Sleep 0.5
Enter 2
Sleep 0.5
Type "Sincerely,"
Sleep 0.5
Enter
Sleep 0.5
Type "Charm_"
Sleep 2
Tab
Sleep 1
Enter
Sleep 1
Escape
Sleep 1
Tab
Sleep 1
Enter
Sleep 5