diggy 1.0.0 → 1.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "diggy",
-	"version": "1.0.0",
+	"version": "1.0.1",
 	"description": "Multi-backend DNS resolver for Node.js/Browser — supports dig, DNS over HTTPS, and native Node.js DNS.",
 	"repository": "git@github.com:OzzyCzech/diggy.git",
 	"author": "Roman Ožana <roman@ozana.cz>",

package/readme.md

@@ -1,5 +1,11 @@
 # 👾 Diggy
 
+[![NPM Downloads](https://img.shields.io/npm/dm/diggy?style=for-the-badge)](https://www.npmjs.com/package/diggy)
+[![NPM Version](https://img.shields.io/npm/v/diggy?style=for-the-badge)](https://www.npmjs.com/package/diggy)
+[![NPM License](https://img.shields.io/npm/l/diggy?style=for-the-badge)](https://github.com/OzzyCzech/diggy/blob/main/LICENSE)
+[![Last Commit](https://img.shields.io/github/last-commit/OzzyCzech/diggy?style=for-the-badge)](https://github.com/OzzyCzech/diggy/commits/main)
+[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/OzzyCzech/diggy/main.yml?style=for-the-badge)](https://github.com/OzzyCzech/diggy/actions)
+
 👾 **Diggy** is a flexible, multi-backend JavaScript **DNS resolver** for fetching **DNS records**
 with support for various resolution methods including DNS over HTTPS, native `dig` commands, and Node.js built-in DNS
 functionality.
@@ -60,9 +66,9 @@ const records: AnyDNSRecord[] = await getDnsRecords('example.com', 'A');
 
 ```typescript
 function getDnsRecords(
-  host: string,
-  type?: string,
-  resolver?: string | BuildInDNSResolver | DNSResolver,
+	host: string,
+	type?: string,
+	resolver?: string | BuildInDNSResolver | DNSResolver,
 ): Promise<AnyDNSRecord[]>
 ```
 
@@ -74,6 +80,20 @@ function getDnsRecords(
 
 **Returns:** Promise resolving to an array of DNS records
 
+## 🌍 Browser Usage
+
+You can also use Diggy in the browser via ESM imports. This allows you to fetch DNS records directly from client-side
+JavaScript. There are built-in resolvers for Google and Cloudflare DNS over HTTPS, which work seamlessly in the browser.
+
+```html
+
+<script type="module">
+	import { getDnsRecords } from 'https://esm.sh/diggy';
+	
+	const records = await getDnsRecords('ozana.cz');
+</script>
+```
+
 ## 🌐 Available Resolvers
 
 ### Built-in Resolvers
@@ -94,12 +114,12 @@ const records = await getDnsRecords('example.com', 'A', "nodejs");
 const records = await getDnsRecords('example.com', 'A', "dig");
 ```
 
-| Resolver     | Description                 | Environment               |
-|--------------|-----------------------------|---------------------------|
-| `google`     | Google DNS over HTTPS       | Works in Browser          |
-| `cloudflare` | Cloudflare DNS over HTTPS   | Works in Browser          |
-| `nodejs`     | Node.js built-in DNS module | Node.js runtime           |
-| `dig`        | Native dig command          | `dig` installed on system |
+| Resolver     | Description                 | Environment                            | 
+|--------------|-----------------------------|----------------------------------------|
+| `google`     | Google DNS over HTTPS       | Browsers, Node.js                      | 
+| `cloudflare` | Cloudflare DNS over HTTPS   | Browsers, Node.js                      | 
+| `nodejs`     | Node.js built-in DNS module | Node.js only                           | 
+| `dig`        | Native dig command          | Node.js only, requires `dig` installed | 
 
 ### Configure built-in resolvers
 
@@ -134,8 +154,8 @@ You can also **create your own custom resolver** by implementing the `DNSResolve
 
 ```typescript
 export type DNSResolver = (
-  host: string,
-  type: DNSRecordType,
+	host: string,
+	type: DNSRecordType,
 ) => Promise<AnyDNSRecord[]>;
 ```
 
@@ -161,19 +181,19 @@ DNS records are returned as an array of objects with the following structure:
 import { CaaRecordData, MxRecordData, SoaRecordData, SrvRecordData, NaptrRecordData } from "./types";
 
 interface AnyDNSRecord {
-  name: string;    // Domain name
-  type: string;    // Record type (A, AAAA, MX, etc.)
-  ttl: number;     // Time-to-live in seconds
-
-  // Record data (format varies by type)
-  data:
-    | string
-    | string[]
-    | MxRecordData
-    | SoaRecordData
-    | CaaRecordData
-    | NaptrRecordData
-    | SrvRecordData;
+	name: string;    // Domain name
+	type: string;    // Record type (A, AAAA, MX, etc.)
+	ttl: number;     // Time-to-live in seconds
+
+	// Record data (format varies by type)
+	data:
+		| string
+		| string[]
+		| MxRecordData
+		| SoaRecordData
+		| CaaRecordData
+		| NaptrRecordData
+		| SrvRecordData;
 }
 ```
 
@@ -181,35 +201,35 @@ interface AnyDNSRecord {
 
 ```json
 [
-  {
-    "name": "example.com",
-    "type": "SOA",
-    "ttl": 3600,
-    "data": {
-      "nsname": "ns1.example.com.",
-      "hostmaster": "hostmaster.example.com.",
-      "serial": 2025051204,
-      "refresh": 10800,
-      "retry": 3600,
-      "expire": 604800,
-      "minttl": 3600
-    }
-  },
-  {
-    "name": "example.cz",
-    "type": "A",
-    "ttl": 1800,
-    "data": "66.33.66.33"
-  },
-  {
-    "name": "example.cz",
-    "type": "MX",
-    "ttl": 60,
-    "data": {
-      "priority": 10,
-      "exchange": "mail.example.com"
-    }
-  }
+	{
+		"name": "example.com",
+		"type": "SOA",
+		"ttl": 3600,
+		"data": {
+			"nsname": "ns1.example.com.",
+			"hostmaster": "hostmaster.example.com.",
+			"serial": 2025051204,
+			"refresh": 10800,
+			"retry": 3600,
+			"expire": 604800,
+			"minttl": 3600
+		}
+	},
+	{
+		"name": "example.cz",
+		"type": "A",
+		"ttl": 1800,
+		"data": "66.33.66.33"
+	},
+	{
+		"name": "example.cz",
+		"type": "MX",
+		"ttl": 60,
+		"data": {
+			"priority": 10,
+			"exchange": "mail.example.com"
+		}
+	}
 ]
 ```