dip/vendor/github.com/likexian/whois/README.md
Paul Lecuq c320cc8133
All checks were successful
continuous-integration/drone/push Build is passing
updated dip, removing packr, updated dependencies, fixes
2022-08-18 01:16:43 +02:00

91 lines
2.0 KiB
Markdown

# Whois
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
[![GoDoc](https://pkg.go.dev/badge/github.com/likexian/whois.svg)](https://pkg.go.dev/github.com/likexian/whois)
[![Go Report Card](https://goreportcard.com/badge/github.com/likexian/whois)](https://goreportcard.com/report/github.com/likexian/whois)
[![Build Status](https://github.com/likexian/whois/actions/workflows/gotest.yaml/badge.svg)](https://github.com/likexian/whois/actions/workflows/gotest.yaml)
[![Code Cover](https://release.likexian.com/whois/coverage.svg)](https://github.com/likexian/whois/actions/workflows/gotest.yaml)
Whois is a simple Go module for domain and ip whois information query.
## Overview
All of domain, IP include IPv4 and IPv6, ASN are supported.
You can directly using the binary distributions whois, follow [whois release tool](cmd/whois).
Or you can do development by using this golang module as below.
## Installation
```shell
go get -u github.com/likexian/whois
```
## Importing
```go
import (
"github.com/likexian/whois"
)
```
## Documentation
Visit the docs on [GoDoc](https://pkg.go.dev/github.com/likexian/whois)
## Example
### whois query for domain
```go
result, err := whois.Whois("likexian.com")
if err == nil {
fmt.Println(result)
}
```
### whois query for IPv6
```go
result, err := whois.Whois("2001:dc7::1")
if err == nil {
fmt.Println(result)
}
```
### whois query for IPv4
```go
result, err := whois.Whois("1.1.1.1")
if err == nil {
fmt.Println(result)
}
```
### whois query for ASN
```go
// or whois.Whois("AS60614")
result, err := whois.Whois("60614")
if err == nil {
fmt.Println(result)
}
```
## Whois information parsing
Please refer to [whois-parser](https://github.com/likexian/whois-parser)
## License
Copyright 2014-2022 [Li Kexian](https://www.likexian.com/)
Licensed under the Apache License 2.0
## Donation
If this project is helpful, please share it with friends.
If you want to thank me, you can [give me a cup of coffee](https://www.likexian.com/donate/).