From fddd22f20a9bf58309998656703d564430a2ddd9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Przemys=C5=82aw=20=C5=BBydek?= Date: Thu, 28 Sep 2023 12:23:48 +0200 Subject: [PATCH 1/6] docs(README): add requirements section --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 311137d..0354f67 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,7 @@ Fingerprint Pro React SDK is an easy way to integrate **[Fingerprint Pro](https: ## Table of contents - [Installation](#installation) +- [Requirements](#requirements) - [Getting started](#getting-started) - [Caching strategy](#caching-strategy) - [Error handling](#error-handling) @@ -58,6 +59,20 @@ Using [yarn](https://yarnpkg.com): yarn add @fingerprintjs/fingerprintjs-pro-react ``` +Using [pnpm](https://pnpm.js.org): + +```sh +pnpm add @fingerprintjs/fingerprintjs-pro-react +``` + +## Requirements + +- React 18 or higher +- For Preact users: Preact 10.3 or higher +- For Next.js users: Next.js 13.1 or higher +- For Typescript users: Typescript 4.8 or higher + + ## Getting started In order to identify visitors, you'll need a Fingerprint Pro account (you can [sign up for free](https://dashboard.fingerprint.com/signup/)). From bb1359b7771f54124710627042ead4ba0e9e015d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Przemys=C5=82aw=20=C5=BBydek?= Date: Thu, 5 Oct 2023 14:55:36 +0300 Subject: [PATCH 2/6] docs: add intro section --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 0354f67..5cf7223 100644 --- a/README.md +++ b/README.md @@ -31,8 +31,7 @@ # Fingerprint Pro React - -Fingerprint Pro React SDK is an easy way to integrate **[Fingerprint Pro](https://fingerprint.com/)** into your React application. It's also compatible with Next.js and Preact. See application demos in the [examples](https://github.com/fingerprintjs/fingerprintjs-pro-react/tree/main/examples) folder. **This package works with Fingerprint Pro, it is not compatible with [open-source FingerprintJS](https://github.com/fingerprintjs/fingerprintjs).** You can learn more about the difference between Fingerprint Pro and open-source FingerprintJS in the [official documentation](https://dev.fingerprint.com/docs/pro-vs-open-source). +Fingerprint is a device intelligence platform offering 99.5% accurate visitor identification. Fingerprint Pro React SDK is an easy way to integrate **[Fingerprint Pro](https://fingerprint.com/)** into your React application. It's also compatible with Next.js and Preact. See application demos in the [examples](https://github.com/fingerprintjs/fingerprintjs-pro-react/tree/main/examples) folder. **This package works with Fingerprint Pro, it is not compatible with [open-source FingerprintJS](https://github.com/fingerprintjs/fingerprintjs).** You can learn more about the difference between Fingerprint Pro and open-source FingerprintJS in the [official documentation](https://dev.fingerprint.com/docs/pro-vs-open-source). ## Table of contents From 39137ea80a6d5ed45ebb1dbb761078f8f9c435fd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Przemys=C5=82aw=20=C5=BBydek?= Date: Thu, 5 Oct 2023 14:56:01 +0300 Subject: [PATCH 3/6] docs: move requirements to top --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 5cf7223..fdcffaa 100644 --- a/README.md +++ b/README.md @@ -35,8 +35,8 @@ Fingerprint is a device intelligence platform offering 99.5% accurate visitor id ## Table of contents -- [Installation](#installation) - [Requirements](#requirements) +- [Installation](#installation) - [Getting started](#getting-started) - [Caching strategy](#caching-strategy) - [Error handling](#error-handling) @@ -44,6 +44,13 @@ Fingerprint is a device intelligence platform offering 99.5% accurate visitor id - [Support and feedback](#support-and-feedback) - [License](#license) +## Requirements + +- React 18 or higher +- For Preact users: Preact 10.3 or higher +- For Next.js users: Next.js 13.1 or higher +- For Typescript users: Typescript 4.8 or higher + ## Installation Using [npm](https://npmjs.org): @@ -64,13 +71,6 @@ Using [pnpm](https://pnpm.js.org): pnpm add @fingerprintjs/fingerprintjs-pro-react ``` -## Requirements - -- React 18 or higher -- For Preact users: Preact 10.3 or higher -- For Next.js users: Next.js 13.1 or higher -- For Typescript users: Typescript 4.8 or higher - ## Getting started From 69cfa3c1d43dbf6fad225eb178e691dee6f4f7b7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Przemys=C5=82aw=20=C5=BBydek?= Date: Thu, 5 Oct 2023 14:58:22 +0300 Subject: [PATCH 4/6] docs: add FingerprintJS vs Pro section note --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index fdcffaa..a928174 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,8 @@ Fingerprint is a device intelligence platform offering 99.5% accurate visitor id - For Next.js users: Next.js 13.1 or higher - For Typescript users: Typescript 4.8 or higher +Note: This package assumes you have a Fingerprint Pro subscription or trial, it is not compatible with the [source-available FingerprintJS](https://github.com/fingerprintjs/fingerprintjs). See our documentation to learn more about the [differences between Fingerprint Pro and FingerprintJS](https://dev.fingerprint.com/docs/identification-vs-fingerprintjs). + ## Installation Using [npm](https://npmjs.org): From ff03d4359f1604439d40708789212dd7184151c7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Przemys=C5=82aw=20=C5=BBydek?= Date: Tue, 10 Oct 2023 15:46:12 +0300 Subject: [PATCH 5/6] docs: replace logo --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a928174..a1e2efe 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@

- - - - Fingerprint logo + + + + Fingerprint logo

From de300878053b4f46cafefc7d75e4cb4e4a6055b9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Przemys=C5=82aw=20=C5=BBydek?= Date: Wed, 11 Oct 2023 11:25:24 +0300 Subject: [PATCH 6/6] docs: remove comparison from title --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a1e2efe..29d4037 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ # Fingerprint Pro React -Fingerprint is a device intelligence platform offering 99.5% accurate visitor identification. Fingerprint Pro React SDK is an easy way to integrate **[Fingerprint Pro](https://fingerprint.com/)** into your React application. It's also compatible with Next.js and Preact. See application demos in the [examples](https://github.com/fingerprintjs/fingerprintjs-pro-react/tree/main/examples) folder. **This package works with Fingerprint Pro, it is not compatible with [open-source FingerprintJS](https://github.com/fingerprintjs/fingerprintjs).** You can learn more about the difference between Fingerprint Pro and open-source FingerprintJS in the [official documentation](https://dev.fingerprint.com/docs/pro-vs-open-source). +Fingerprint is a device intelligence platform offering 99.5% accurate visitor identification. Fingerprint Pro React SDK is an easy way to integrate **[Fingerprint Pro](https://fingerprint.com/)** into your React application. It's also compatible with Next.js and Preact. See application demos in the [examples](https://github.com/fingerprintjs/fingerprintjs-pro-react/tree/main/examples) folder. ## Table of contents