Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
haccer authored Jun 5, 2018
1 parent 78c977e commit 57982f6
Showing 1 changed file with 6 additions and 12 deletions.
18 changes: 6 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@
# Is 'domain.x' Available?
[![Build Status](https://api.travis-ci.org/haccer/available.svg?branch=master)](https://travis-ci.org/haccer/available) [![Go Report Card](https://goreportcard.com/badge/github.com/haccer/available)](https://goreportcard.com/report/github.com/haccer/available) [![GitHub license](https://img.shields.io/github/license/haccer/available.svg)](https://github.com/haccer/available/blob/master/LICENSE)
[![Build Status](https://api.travis-ci.org/haccer/available.svg?branch=master)](https://travis-ci.org/haccer/available)
[![Go Report Card](https://goreportcard.com/badge/github.com/haccer/available)](https://goreportcard.com/report/github.com/haccer/available)
[![GoDoc](https://godoc.org/github.com/haccer/available?status.svg)](http://godoc.org/github.com/haccer/available)
[![GitHub license](https://img.shields.io/github/license/haccer/available.svg)](https://github.com/haccer/available/blob/master/LICENSE)
> IN WHOIS WE TRUST
My cheap way of checking whether a domain is available to be purchased or not (powered by [whois](https://github.com/domainr/whois)).

#### Disclaimer
This package won't be able to check the available for _every_ possible domain TLD, since `whois` does not work with some TLDs. In the future, I might include options to call different APIs (Gandi API, etc.).

### Usage
```Go
Domain(available bool, badtld bool)
```
This package _might not_ be able to check the available for _every_ possible domain TLD, since `whois` does not work with some TLDs. In the future, I might include options to call different APIs (Gandi API, Domainr, etc.).

### Example

Expand All @@ -25,11 +23,7 @@ import (
func main() {
domain := "dreamdomain.io"

available, badtld := available.Domain(domain)

if badtld {
fmt.Println("[-] BadTLD. No Whois server to check :(")
}
available := available.Domain(domain)

if available {
fmt.Println("[+] Success!")
Expand Down

0 comments on commit 57982f6

Please sign in to comment.