Skip to content

Commit 20b3066

Browse files
committed
Update readme
1 parent 61e2942 commit 20b3066

File tree

1 file changed

+51
-1
lines changed

1 file changed

+51
-1
lines changed

README.md

+51-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,52 @@
11
# email-me
2-
email me when a thing is done
2+
3+
sometimes you run processes and you want to be emailed when they're done running
4+
5+
```
6+
$ email-me [email protected] ls -lah
7+
```
8+
9+
## Installation
10+
11+
```bash
12+
$ go get github.com/mattrobenolt/email-me
13+
```
14+
15+
## Usage
16+
17+
```
18+
usage: email-me [flags] [command]
19+
-max=10000: max bytes to capture for stdout/stderr
20+
-s="": subject of email (optional)
21+
-to="": email address to send output to
22+
```
23+
24+
## Example email
25+
26+
```
27+
Cmd: [ls -lah]
28+
Start: 2015-06-24 18:43:30.195114617 -0700 PDT
29+
End: 2015-06-24 18:43:30.210375736 -0700 PDT
30+
Duration: 15.261119ms
31+
ProcessState: exit status 0
32+
Error: <nil>
33+
Stderr:
34+
35+
36+
Stdout:
37+
total 72
38+
drwxr-xr-x 14 matt staff 476B Jun 24 18:43 .
39+
drwxr-xr-x@ 219 matt staff 7.3K Jun 24 18:10 ..
40+
-rw-r--r-- 1 matt staff 34B Jun 24 18:38 .dockerignore
41+
drwxr-xr-x 13 matt staff 442B Jun 24 18:43 .git
42+
-rw-r--r-- 1 matt staff 275B Jun 24 18:38 .gitignore
43+
-rw-r--r-- 1 matt staff 507B Jun 24 17:32 Dockerfile
44+
-rw-r--r-- 1 matt staff 397B Jun 24 18:43 README.md
45+
drwxr-xr-x 12 matt staff 408B Jun 24 18:39 bin
46+
-rwxr-xr-x 1 matt staff 113B Jun 24 17:32 build.sh
47+
-rw-r--r-- 1 matt staff 1.5K Jun 24 18:32 command.go
48+
-rw-r--r-- 1 matt wheel 2.0K Jun 24 18:36 main.go
49+
-rw-r--r-- 1 matt staff 263B Jun 24 17:25 sendmail.go
50+
-rw-r--r-- 1 matt staff 193B Jun 24 17:26 smtp.go
51+
drwxr-xr-x 3 matt staff 102B Jun 24 18:18 src
52+
```

0 commit comments

Comments
 (0)