diff --git a/README.md b/README.md index 993d1ea..6c1acab 100644 --- a/README.md +++ b/README.md @@ -73,6 +73,58 @@ go install github.com/charmbracelet/pop@latest Or download a binary from the [releases](https://github.com/charmbracelet/pop/releases). +## Examples + +Pop can be combined with other tools to create powerful email pipelines, such as: + +* [`charmbracelet/mods`](https://github.com/charmbracelet/mods) +* [`charmbracelet/gum`](https://github.com/charmbracelet/gum) +* [`maaslalani/invoice`](https://github.com/maaslalani/invoice) + +### Mods + +Use [`mods`](https://github.com/charmbracelet/mods) with `pop` to write an email body with AI: + +> **Note**: +> Use the `--preview` flag to preview the email and make changes before sending. + +```bash +pop --body '$(mods -f "Write an email about how the command line is the best.")' + --subject '$(mods "Write a catchy email subject about the command line is the best computing platform.")' + --preview +``` + +Generate email with mods and send email with pop. + +* [`charmbracelet/mods`](https://github.com/charmbracelet/mods) + +### Gum + +Use [`gum`](https://github.com/charmbracelet/gum) with `pop` to choose an email to send to and from: + +```bash +pop --from $(gum choose "vt52@charm.sh" "vt78@charm.sh" "vt100@charm.sh") + --to $(gum filter < contacts.txt) +``` + +Select contact information with gum and send email with pop. + +* [`charmbracelet/gum`](https://github.com/charmbracelet/gum) + +### Invoice + +Use [`invoice`](https://github.com/maaslalani/invoice) with `pop` to generate and send invoices entirely from the command line. + +```bash +FILENAME=invoice.pdf +invoice generate --item "Rubber Ducky" --rate 25 --quantity 2 --output $FILENAME +pop --attach $FILENAME --to client@example.com --from rubberducky@quack.com --body "See attached invoice." +``` + +Generate invoice with invoice and attach file and send email with pop. + +* [`maaslalani/invoice`](https://github.com/maaslalani/invoice) + ## License [MIT](https://github.com/charmbracelet/pop/blob/main/LICENSE)