docs: readme

This commit is contained in:
Maas Lalani 2023-06-14 00:52:36 -04:00
parent 7952e251bd
commit 2b19a65b4c
No known key found for this signature in database
GPG key ID: 5A6ED5CBF1A0A000

64
README.md Normal file
View file

@ -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
<!--
Use a package manager:
```bash
# macOS
brew install email
# Arch
yay -S email
# Nix
nix-env -iA nixpkgs.email
```
-->
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)
---
<sub><sub>z</sub></sub><sub>z</sub>z