Skip to content

Commit a24f459

Browse files
committed
docs: add migration notice and gfxbench deprecation warning
1 parent a9cf1b9 commit a24f459

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,16 @@
44
[![npm downloads](https://img.shields.io/npm/dm/@pmndrs/detect-gpu.svg)](https://www.npmjs.com/package/@pmndrs/detect-gpu)
55
[![gzip size](https://img.badgesize.io/https:/unpkg.com/@pmndrs/detect-gpu/dist/index.mjs?compression=gzip)](https://unpkg.com/@pmndrs/detect-gpu)
66

7+
> **Migrating from `detect-gpu`?** This package has moved to `@pmndrs/detect-gpu`. Update your imports:
8+
> ```diff
9+
> - import { getGPUTier } from 'detect-gpu';
10+
> + import { getGPUTier } from '@pmndrs/detect-gpu';
11+
> ```
12+
713
Classifies GPUs based on their 3D rendering benchmark score allowing the developer to provide sensible default settings for graphically intensive applications. Think of it like a user-agent detection for the GPU but more powerful.
814
15+
> **Note:** Our benchmark data source ([gfxbench.com](https://gfxbench.com)) stopped updating in December 2025. The current data remains accurate for existing GPUs, but we are exploring alternative data sources for future updates. See [#132](https://github.com/pmndrs/detect-gpu/issues/132) for progress.
16+
917
## Demo
1018
1119
[Live demo](https://pmndrs.github.io/detect-gpu/)
@@ -14,10 +22,18 @@ Classifies GPUs based on their 3D rendering benchmark score allowing the develop
1422
1523
By default we use the [UNPKG](https://unpkg.com) CDN to host the benchmark data. If you would like to serve the benchmark data yourself download the required benchmarking data from [benchmarks.tar.gz](https://github.com/pmndrs/detect-gpu/raw/master/benchmarks.tar.gz) and serve it from a public directory.
1624
25+
```sh
26+
yarn add @pmndrs/detect-gpu
27+
```
28+
1729
```sh
1830
npm install @pmndrs/detect-gpu
1931
```
2032

33+
```sh
34+
pnpm add @pmndrs/detect-gpu
35+
```
36+
2137
## Usage
2238

2339
```ts
@@ -46,7 +62,7 @@ getGPUTier({
4662
/**
4763
* URL of directory where benchmark data is hosted.
4864
*
49-
* @default https://unpkg.com/detect-gpu@{version}/dist/benchmarks
65+
* @default https://unpkg.com/@pmndrs/detect-gpu@{version}/dist/benchmarks
5066
*/
5167
benchmarksURL?: string;
5268
/**

0 commit comments

Comments
 (0)