Skip to content

Commit d9d9835

Browse files
docs: update links and integration instructions in README and contributing guide
1 parent b196ff5 commit d9d9835

2 files changed

Lines changed: 9 additions & 11 deletions

File tree

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Fingerprint is a device intelligence platform offering industry-leading accuracy
4646
- For Typescript users: Typescript 4.8 or higher
4747

4848
> [!NOTE]
49-
> 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).
49+
> 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://docs.fingerprint.com/docs/identification-vs-fingerprintjs).
5050
5151
## Installation
5252

@@ -71,14 +71,14 @@ pnpm add @fingerprintjs/fingerprintjs-pro-react
7171
## Getting started
7272

7373
In order to identify visitors, you'll need a Fingerprint Pro account (you can [sign up for free](https://dashboard.fingerprint.com/signup/)).
74-
To get your API key and get started, see the [Fingerprint Pro Quick Start Guide](https://dev.fingerprint.com/docs/quick-start-guide).
74+
To get your API key and get started, see the [Fingerprint Pro Quick Start Guide](https://docs.fingerprint.com/docs/quick-start-guide).
7575

7676
### 1. Wrap your application (or component) in `<FpProvider>`.
7777

7878
- Set `apiKey` to your Fingerprint [Public API Key](https://dashboard.fingerprint.com/api-keys).
79-
- Set `region` if you have chosen a non-global [region](https://dev.fingerprint.com/docs/regions) during registration.
80-
- Set `endpoint` and `scriptUrlPattern` if you are using [one of our proxy integrations to increase accuracy](https://dev.fingerprint.com/docs/protecting-the-javascript-agent-from-adblockers) and effectiveness of visitor identification.
81-
- You can use all the [load options](https://dev.fingerprint.com/reference/load-function#load-options) available in the JavaScript agent `load` function.
79+
- Set `region` if you have chosen a non-global [region](https://docs.fingerprint.com/docs/regions) during registration.
80+
- Set `endpoint`` if you are using [one of our proxy integrations to increase accuracy](https://docs.fingerprint.com/docs/protecting-the-javascript-agent-from-adblockers) and effectiveness of visitor identification.
81+
- You can use all the [start options](https://docs.fingerprint.com/reference/js-agent-v4-start-function#start-options) available in the JavaScript agent `load` function.
8282

8383
```jsx
8484
// src/index.js
@@ -133,7 +133,7 @@ The `useVisitorData` hook also returns a `getData` method you can use to make an
133133

134134
- You can pass `{ immediate: false }` to `useVisitorData` to disable automatic visitor identification on render.
135135

136-
Both `useVisitorData` and `getData` accept all the [get options](https://dev.fingerprint.com/reference/get-function#get-options) available in the JavaScript agent `get` function.
136+
Both `useVisitorData` and `getData` accept all the [get options](https://docs.fingerprint.com/reference/get-function#get-options) available in the JavaScript agent `get` function.
137137

138138
```jsx
139139
// src/App.js
@@ -189,7 +189,7 @@ export default App
189189

190190
## Linking and tagging information
191191

192-
The `visitorId` provided by Fingerprint Identification is especially useful when combined with information you already know about your users, for example, account IDs, order IDs, etc. To learn more about various applications of the `linkedId` and `tag`, see [Linking and tagging information](https://dev.fingerprint.com/docs/tagging-information).
192+
The `visitorId` provided by Fingerprint Identification is especially useful when combined with information you already know about your users, for example, account IDs, order IDs, etc. To learn more about various applications of the `linkedId` and `tag`, see [Linking and tagging information](https://docs.fingerprint.com/docs/tagging-information).
193193

194194
Associate the visitor ID with your data using the `linkedId` or `tag` parameter of the options object passed into the `useVisitorData()` hook or the `getData` function:
195195

@@ -209,7 +209,7 @@ function App() {
209209

210210
## Error handling
211211

212-
The `getData` function throws errors directly from the JS Agent without changing them. See [JS Agent error handling](https://dev.fingerprint.com/reference/error-handling) for more details.
212+
The `getData` function throws errors directly from the JS Agent without changing them. See [JS Agent error handling](https://docs.fingerprint.com/reference/js-agent-v4-error-handling) for more details.
213213

214214
## API Reference
215215

contributing.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,7 @@ There are 4 demo pages for this integration:
1616
4. In `/examples/preact` folder. It is a demo built with Preact. You can find more info about configuration and starting demo in the [readme](examples/preact/README.md).
1717
5. In `/examples/webpack-based` folder. It is a simple demo built with raw webpack.
1818

19-
If you want to test integration with [fingerprintjs-pro-spa](https://github.com/fingerprintjs/fingerprintjs-pro-spa), just [link the package](https://pnpm.io/cli/link#replace-an-installed-package-with-a-local-version-of-it) with the `pnpm link <spa-directory>`.
20-
21-
❗ Build projects before testing integration. First build `fingerprintjs-pro-spa`, then `fingerprintjs-pro-react`, and then start spa example app.
19+
❗ Build projects before testing integration. First build `fingerprintjs-pro-react`, and then start any of the example apps.
2220

2321
### How to build
2422

0 commit comments

Comments
 (0)