Skip to content

Commit 31a4461

Browse files
committed
fix: fixed slug
1 parent 627ceed commit 31a4461

File tree

5 files changed

+19
-19
lines changed

5 files changed

+19
-19
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
<h1 align="center">
2-
<a href="https://github.com/forwardemail/tangerine"><img src="https://raw.githubusercontent.com/forwardemail/tangerine/main/media/header.png" alt="Tangerine" /></a>
2+
<a href="https://github.com/forwardemail/nodejs-dns-over-https-tangerine"><img src="https://raw.githubusercontent.com/forwardemail/nodejs-dns-over-https-tangerine/main/media/header.png" alt="Tangerine" /></a>
33
</h1>
44
<div align="center">
5-
<a href="https://github.com/forwardemail/tangerine/actions/workflows/ci.yml"><img src="https://github.com/forwardemail/tangerine/actions/workflows/ci.yml/badge.svg" alt="build status" /></a>
5+
<a href="https://github.com/forwardemail/nodejs-dns-over-https-tangerine/actions/workflows/ci.yml"><img src="https://github.com/forwardemail/nodejs-dns-over-https-tangerine/actions/workflows/ci.yml/badge.svg" alt="build status" /></a>
66
<a href="https://github.com/sindresorhus/xo"><img src="https://img.shields.io/badge/code_style-XO-5ed9c7.svg" alt="code style" /></a>
77
<a href="https://github.com/prettier/prettier"><img src="https://img.shields.io/badge/styled_with-prettier-ff69b4.svg" alt="styled with prettier" /></a>
88
<a href="https://lass.js.org"><img src="https://img.shields.io/badge/made_with-lass-95CC28.svg" alt="made with lass" /></a>
9-
<a href="LICENSE"><img src="https://img.shields.io/github/license/forwardemail/tangerine.svg" alt="license" /></a>
9+
<a href="LICENSE"><img src="https://img.shields.io/github/license/forwardemail/nodejs-dns-over-https-tangerine.svg" alt="license" /></a>
1010
<a href="https://npm.im/tangerine"><img src="https://img.shields.io/npm/dt/tangerine.svg" alt="npm downloads" /></a>
1111
</div>
1212
<br />
1313
<div align="center">
14-
🍊 <a href="https://github.com/forwardemail/tangerine" target="_blank">Tangerine</a> is the best <a href="https://nodejs.org" target="_blank">Node.js</a> drop-in replacement for <a href="https://nodejs.org/api/dns.html#resolveroptions" target="_blank">dns.promises.Resolver</a> using <a href="https://en.wikipedia.org/wiki/DNS_over_HTTPS" target="_blank">DNS over HTTPS</a> ("DoH") via <a href="https://github.com/nodejs/undici" target="_blank">undici</a> with built-in retries, timeouts, smart server rotation, <a href="https://developer.mozilla.org/en-US/docs/Web/API/AbortController" target="_blank">AbortControllers</a>, and caching support for multiple backends (with TTL and purge support).
14+
🍊 <a href="https://github.com/forwardemail/nodejs-dns-over-https-tangerine" target="_blank">Tangerine</a> is the best <a href="https://nodejs.org" target="_blank">Node.js</a> drop-in replacement for <a href="https://nodejs.org/api/dns.html#resolveroptions" target="_blank">dns.promises.Resolver</a> using <a href="https://en.wikipedia.org/wiki/DNS_over_HTTPS" target="_blank">DNS over HTTPS</a> ("DoH") via <a href="https://github.com/nodejs/undici" target="_blank">undici</a> with built-in retries, timeouts, smart server rotation, <a href="https://developer.mozilla.org/en-US/docs/Web/API/AbortController" target="_blank">AbortControllers</a>, and caching support for multiple backends (with TTL and purge support).
1515
</div>
1616
<hr />
1717
<div align="center">
@@ -228,7 +228,7 @@ tangerine.resolve('forwardemail.net').then(console.log);
228228

229229
* Specify default request options based off the library under `requestOptions` below
230230
* Instance methods of [dns.promises.Resolver](https://nodejs.org/api/dns.html) are mirrored to :tangerine: Tangerine.
231-
* Resolver methods accept an optional `abortController` argument, which is an instance of [AbortController](https://developer.mozilla.org/en-US/docs/Web/API/AbortController). Note that :tangerine: Tangerine manages `AbortController` usage internally – so you most likely won't need to pass your own (see [index.js](https://github.com/forwardemail/tangerine/blob/main/index.js) for more insight).
231+
* Resolver methods accept an optional `abortController` argument, which is an instance of [AbortController](https://developer.mozilla.org/en-US/docs/Web/API/AbortController). Note that :tangerine: Tangerine manages `AbortController` usage internally – so you most likely won't need to pass your own (see [index.js](https://github.com/forwardemail/nodejs-dns-over-https-tangerine/blob/main/index.js) for more insight).
232232
* Resolver methods that accept `options` argument also accept an optional `options.purgeCache` option.
233233
* Resolver methods support a `purgeCache` option as either `options.purgeCache` (Boolean) via `options` argument or `purgeCache` (Boolean) argument – see [API](#api) and [Cache](#cache) for more insight.
234234
* If set to `true`, then the result will be re-queried and re-cached – see [Cache](#cache) documentation for more insight.
@@ -295,7 +295,7 @@ This mirrors output from <https://github.com/rthalley/dnspython>.
295295

296296
### `tangerine.resolveTlsa(hostname[, options, abortController]))`
297297

298-
This method was added for DANE and TLSA support. See this [excellent article](https://www.mailhardener.com/kb/dane), [index.js](https://github.com/forwardemail/tangerine/blob/main/index.js), and <https://github.com/nodejs/node/issues/39569> for more insight.
298+
This method was added for DANE and TLSA support. See this [excellent article](https://www.mailhardener.com/kb/dane), [index.js](https://github.com/forwardemail/nodejs-dns-over-https-tangerine/blob/main/index.js), and <https://github.com/nodejs/node/issues/39569> for more insight.
299299

300300
This function returns a Promise that resolves with an Array with parsed values from results:
301301

@@ -381,7 +381,7 @@ console.log('mx', mx);
381381
382382
## Options
383383
384-
Similar to the `options` argument from `new dns.promises.Resolver(options)` invocation – :tangerine: Tangerine also has its own options with default `dns` behavior mirrored. See [index.js](https://github.com/forwardemail/tangerine/blob/main/index.js) for more insight into how these options work.
384+
Similar to the `options` argument from `new dns.promises.Resolver(options)` invocation – :tangerine: Tangerine also has its own options with default `dns` behavior mirrored. See [index.js](https://github.com/forwardemail/nodejs-dns-over-https-tangerine/blob/main/index.js) for more insight into how these options work.
385385
386386
| Property | Type | Default Value | Description |
387387
| ------------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -507,7 +507,7 @@ If you run into issues while using :tangerine: Tangerine, then these recommendat
507507
Contributors can run benchmarks locally by cloning the repository, installing dependencies, and running the benchmarks script:
508508
509509
```sh
510-
git clone https://github.com/forwardemail/tangerine.git
510+
git clone https://github.com/forwardemail/nodejs-dns-over-https-tangerine.git
511511
cd tangerine
512512
npm install
513513
npm run benchmarks
@@ -523,9 +523,9 @@ BENCHMARK_PROTOCOL="http" BENCHMARK_HOST="127.0.0.1" BENCHMARK_PORT="4000" BENCH
523523
524524
We have written extensive benchmarks to show that :tangerine: Tangerine is as fast as the native Node.js DNS module (with the exception of the `lookup` command). Note that performance is opinionated – since rate limiting plays a factor dependent on the DNS servers you are using and since caching is most likely going to takeover.
525525
526-
The latest benchmark results are viewable on GitHub under this repository's [GitHub CI actions logs](https://github.com/forwardemail/tangerine/actions?query=event%3Apush):
526+
The latest benchmark results are viewable on GitHub under this repository's [GitHub CI actions logs](https://github.com/forwardemail/nodejs-dns-over-https-tangerine/actions?query=event%3Apush):
527527
528-
> [Node 16 on ubuntu-latest](https://github.com/forwardemail/tangerine/actions/runs/4297805550/jobs/7491228635#step:6:1)
528+
> [Node 16 on ubuntu-latest](https://github.com/forwardemail/nodejs-dns-over-https-tangerine/actions/runs/4297805550/jobs/7491228635#step:6:1)
529529
530530
```diff
531531
node benchmarks/lookup && node benchmarks/resolve && node benchmarks/reverse
@@ -562,7 +562,7 @@ dns.promises.reverse with caching x 5,123,900 ops/sec ±0.96% (85 runs sampled)
562562
+Fastest without caching is: tangerine.reverse GET without caching
563563
```
564564
565-
> [Node 18 on ubuntu latest](https://github.com/forwardemail/tangerine/actions/runs/4297805550/jobs/7491228742#step:6:1)
565+
> [Node 18 on ubuntu latest](https://github.com/forwardemail/nodejs-dns-over-https-tangerine/actions/runs/4297805550/jobs/7491228742#step:6:1)
566566
567567
```diff
568568
node benchmarks/lookup && node benchmarks/resolve && node benchmarks/reverse && node benchmarks/http
@@ -736,4 +736,4 @@ Fastest is undici GET request
736736
737737
##
738738
739-
<a href="#"><img src="https://raw.githubusercontent.com/forwardemail/tangerine/main/media/footer.png" alt="#" /></a>
739+
<a href="#"><img src="https://raw.githubusercontent.com/forwardemail/nodejs-dns-over-https-tangerine/main/media/footer.png" alt="#" /></a>

config.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
docute.init({
33
debug: true,
44
title: 'Tangerine',
5-
repo: 'forwardemail/tangerine',
6-
'edit-link': 'https://github.com/forwardemail/tangerine/tree/main/',
5+
repo: 'forwardemail/nodejs-dns-over-https-tangerine',
6+
'edit-link': 'https://github.com/forwardemail/nodejs-dns-over-https-tangerine/tree/main/',
77
nav: {
88
default: [
99
{

index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
<meta property="og:type" content="website" />
3030
<meta
3131
property="og:image"
32-
content="https://raw.githubusercontent.com/forwardemail/tangerine/main/media/header.png"
32+
content="https://raw.githubusercontent.com/forwardemail/nodejs-dns-over-https-tangerine/main/media/header.png"
3333
/>
3434
</head>
3535

index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1956,7 +1956,7 @@ class Tangerine extends dns.promises.Resolver {
19561956
default: {
19571957
this.options.logger.error(
19581958
new Error(
1959-
`Submit a PR at <https://github.com/forwardemail/tangerine> with proper parsing for ${rrtype} records. You can reference <https://github.com/rthalley/dnspython/tree/master/dns/rdtypes/ANY> for inspiration.`
1959+
`Submit a PR at <https://github.com/forwardemail/nodejs-dns-over-https-tangerine> with proper parsing for ${rrtype} records. You can reference <https://github.com/rthalley/dnspython/tree/master/dns/rdtypes/ANY> for inspiration.`
19601960
)
19611961
);
19621962
return result.answers;

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"version": "1.5.2",
55
"author": "Forward Email (https://forwardemail.net)",
66
"bugs": {
7-
"url": "https://github.com/forwardemail/tangerine/issues"
7+
"url": "https://github.com/forwardemail/nodejs-dns-over-https-tangerine/issues"
88
},
99
"contributors": [
1010
"Forward Email (https://forwardemail.net)"
@@ -62,7 +62,7 @@
6262
"files": [
6363
"index.js"
6464
],
65-
"homepage": "https://github.com/forwardemail/tangerine",
65+
"homepage": "https://github.com/forwardemail/nodejs-dns-over-https-tangerine",
6666
"keywords": [
6767
"1:1",
6868
"abort",
@@ -153,7 +153,7 @@
153153
},
154154
"repository": {
155155
"type": "git",
156-
"url": "https://github.com/forwardemail/tangerine"
156+
"url": "https://github.com/forwardemail/nodejs-dns-over-https-tangerine"
157157
},
158158
"scripts": {
159159
"ava": "cross-env NODE_ENV=test ava",

0 commit comments

Comments
 (0)