Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
namreg committed Oct 16, 2018
1 parent 4c09dbe commit 1c03686
Showing 1 changed file with 35 additions and 1 deletion.
36 changes: 35 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,38 @@
[![Build Status](https://www.travis-ci.org/namreg/ded.svg?branch=master)](https://www.travis-ci.org/namreg/ded)
[![Go Report Card](https://goreportcard.com/badge/github.com/namreg/ded)](https://goreportcard.com/report/github.com/namreg/ded)
[![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/namreg/ded/blob/master/LICENSE)
[![GoDoc](https://godoc.org/github.com/namreg/ded?status.svg)](https://godoc.org/github.com/namreg/ded)
[![GoDoc](https://godoc.org/github.com/namreg/ded?status.svg)](https://godoc.org/github.com/namreg/ded)

Go package that detects disposable emails based on the list [list](https://github.com/wesbos/burner-email-providers).

_Notice: DED does not check that email address is correct._

### Installation
```bash
go get github.com/namreg/ded
```

### How to use
```go
package main

import (
"fmt"

"github.com/namreg/ded"
)

func main() {
disposable, _ := ded.IsDisposableEmail("[email protected]")
fmt.Println(disposable) // true

disposable, _ = ded.IsDisposableEmail("[email protected]")
fmt.Println(false) // false

disposable, _ := ded.IsDisposableDomain("mail.wtf")
fmt.Println(disposable) // true

disposable, _ = ded.IsDisposableDomain("google.com")
fmt.Println(false) // false
}
```

0 comments on commit 1c03686

Please sign in to comment.