From 17908f7028c0718335eb3d6f47c8a24f84c29860 Mon Sep 17 00:00:00 2001 From: PhilKunz Date: Tue, 15 Nov 2016 22:08:48 +0100 Subject: [PATCH] improve README --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8f579b7..5dc73ca 100644 --- a/README.md +++ b/README.md @@ -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)