Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(README): add requirements section #125

Merged
merged 6 commits into from
Oct 18, 2023
Merged

docs(README): add requirements section #125

Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
fddd22f
docs(README): add requirements section
TheUnderScorer Sep 28, 2023
bb1359b
docs: add intro section
TheUnderScorer Oct 5, 2023
39137ea
docs: move requirements to top
TheUnderScorer Oct 5, 2023
69cfa3c
docs: add FingerprintJS vs Pro section note
TheUnderScorer Oct 5, 2023
ff03d43
docs: replace logo
TheUnderScorer Oct 10, 2023
de30087
docs: remove comparison from title
TheUnderScorer Oct 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@


# 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).
JuroUhlar marked this conversation as resolved.
Show resolved Hide resolved

## Table of contents

- [Requirements](#requirements)
JuroUhlar marked this conversation as resolved.
Show resolved Hide resolved
- [Installation](#installation)
- [Getting started](#getting-started)
- [Caching strategy](#caching-strategy)
Expand All @@ -44,6 +44,15 @@ Fingerprint Pro React SDK is an easy way to integrate **[Fingerprint Pro](https:
- [Support and feedback](#support-and-feedback)
- [License](#license)

## Requirements

- React 18 or higher
- For Preact users: Preact 10.3 or higher
JuroUhlar marked this conversation as resolved.
Show resolved Hide resolved
- 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):
Expand All @@ -58,6 +67,13 @@ Using [yarn](https://yarnpkg.com):
yarn add @fingerprintjs/fingerprintjs-pro-react
```

Using [pnpm](https://pnpm.js.org):

```sh
pnpm add @fingerprintjs/fingerprintjs-pro-react
```


JuroUhlar marked this conversation as resolved.
Show resolved Hide resolved
## 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/)).
Expand Down