From 2b19a65b4ca919a48f1465ac9316c9ab3997fa7d Mon Sep 17 00:00:00 2001 From: Maas Lalani Date: Wed, 14 Jun 2023 00:52:36 -0400 Subject: [PATCH] docs: readme --- README.md | 64 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..b1fd67d --- /dev/null +++ b/README.md @@ -0,0 +1,64 @@ +# Email + +Send emails from your terminal. + +## Command Line Interface + +```bash +email --from "me@example.com" --to "you@example.com" \ + --subject "Hello, world!" --attach invoice.pdf \ + < message.md +``` + + +## Text-based User Interface + +Launch the TUI + +```bash +email +``` + +## Installation + + + +Install with Go: + +```sh +go install github.com/maaslalani/email@main +``` + +Or download a binary from the [releases](https://github.com/maaslalani/email/releases). + +## License + +[MIT](https://github.com/maaslalani/email/blob/master/LICENSE) + +## Feedback + +I'd love to hear your feedback on improving `email`. + +Feel free to reach out via: +* [Email](mailto:maas@lalani.dev) +* [Twitter](https://twitter.com/maaslalani) +* [GitHub issues](https://github.com/maaslalani/email/issues/new) + +--- + +zzz