push.rocks/smartdns
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

improve README

Browse Source
This commit is contained in:
Philipp Kunz 2016-11-15 22:08:48 +01:00
parent c4c459901d
commit 17908f7028
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -18,8 +18,15 @@ smart dns methods written in TypeScript
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
## Usage
we recommend the use of TypeScript
we recommend the use of TypeScript for optimal intellisense
```javascript
import * as dnsly from 'dnsly'
let myDnsly = new dnsly.Dnsly('google') // uses Google DNS Servers e.g 8.8.8.8
myDnsly.getRecord('example.com','AAAA') // returns promise
.then(record => { // AAAA record for google.com
// do something
})
```
[![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks)