mirror of
https://github.com/ivabus/pop
synced 2024-12-04 22:15:08 +03:00
docs: readme
This commit is contained in:
parent
7952e251bd
commit
2b19a65b4c
1 changed files with 64 additions and 0 deletions
64
README.md
Normal file
64
README.md
Normal 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
|
Loading…
Reference in a new issue