Skip to content

Commit 8799aca

Browse files
committed
docs(README): add why and related projects.
1 parent 2e49f1f commit 8799aca

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ Quicklink attempts to make navigations to subsequent pages load faster. It:
1010
* **Checks if the user isn't on a slow connection** (using `navigator.connection.effectiveType`) or has data-saver enabled (using `navigator.connection.saveData`)
1111
* **Prefetches URLs to the links** (using [`<link rel=prefetch>`](https://www.w3.org/TR/resource-hints/#prefetch) or XHR). Provides some control over the request priority (can switch to `fetch()` if supported).
1212

13+
## Why
14+
15+
This project aims to be a drop-in solution for sites to prefetch links based on what is in the user's viewport.
16+
1317
## Installation
1418

1519
For use with [node](http://nodejs.org) and [npm](https://npmjs.com):
@@ -136,6 +140,11 @@ The prefetching provided by `quicklink` can be viewed as a progressive enhanceme
136140

137141
Certain features have layered support. If opting for `{priority:'high'}` and `fetch()` isn't available, XHR will be used instead.
138142

143+
## Related projects
144+
145+
* Using [Gatsby](https://gatsbyjs.org)? You already get most of this for free baked in. It uses `Intersection Observer` to prefetch all of the links that are in view.
146+
* Want a more data-driven approach? See [Guess.js](https://guessjs.com). It uses analytics and machine-learning to prefetch resources based on how users navigate your site. It also has plugins for Webpack and Gatsby.
147+
139148
## License
140149

141150
Licensed under the Apache-2.0 license.

0 commit comments

Comments
 (0)