From 85b29ab02a070f765935dc5ba5d209035afbfce7 Mon Sep 17 00:00:00 2001 From: Maas Lalani Date: Wed, 21 Jun 2023 15:11:55 -0400 Subject: [PATCH] docs: readme --- README.md | 24 ++++++++++++++++-------- demo.tape | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 72 insertions(+), 8 deletions(-) create mode 100644 demo.tape diff --git a/README.md b/README.md index e4da1f7..459ef1d 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,23 @@ # Pop +

+ Latest Release + Go Docs + Build Status +

+ Send emails from your terminal. +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: diff --git a/demo.tape b/demo.tape new file mode 100644 index 0000000..a66958f --- /dev/null +++ b/demo.tape @@ -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