Skip to content

Commit 1d669e6

Browse files
committed
Information about telemetry removed from README
1 parent 3a9aa01 commit 1d669e6

File tree

1 file changed

+0
-49
lines changed

1 file changed

+0
-49
lines changed

README.md

Lines changed: 0 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,6 @@ Usability, consistency, and performance are key focuses of trello.js, and it als
1818
## Table of contents
1919

2020
- [Installation](#installation)
21-
- [Telemetry information collection agreement](#telemetry-information-collection-agreement)
22-
- [Customizing telemetry collection data example](#customizing-telemetry-collection-data-example)
23-
- [Disabling telemetry collection example](#disabling-telemetry-collection-example)
2421
- [Usage](#usage)
2522
- [Key and token pair issuing](#key-and-token-pair-issuing)
2623
- [Client creation and first request](#client-creation-first-request-and-using-algorithm)
@@ -43,52 +40,6 @@ Install with the yarn:
4340
yarn add trello.js
4441
```
4542

46-
## Telemetry information collection agreement
47-
48-
The use of this library may collect, record and transmit data about the operation of the library and related data, as well as potentially personal data, including ip address from which the request is made, user agent from the device from which the request is made, version of the library used, version of the telemetry sending library, name of the invoked method, authorization type information (can be configured), callback information, onResponse middleware usage information, onError middleware usage information, queries usage information, body usage information in queries, HTTP response code (can be configured), request start date and time and response receipt date and time (can be configured), timeout settings.
49-
50-
The type and amount of data may vary with the version of the libraries and can be changed at any time without notice.
51-
52-
Telemetry data collection is enabled by default.
53-
54-
The following tracking parameters can be configured:
55-
56-
- Authentication status
57-
- Request status code
58-
- Request timings
59-
- Timeout information
60-
61-
#### Customizing telemetry collection data example
62-
63-
```typescript
64-
import { Config } from 'trello.js';
65-
66-
const config: Config = {
67-
key: 'YOUR_API_KEY',
68-
token: 'YOUR_API_TOKEN',
69-
telemetry: {
70-
allowedToPassAuthenticationStatus: false, // true by default
71-
allowedToPassRequestStatusCode: true, // true by default
72-
allowedToPassRequestTimings: false, // true by default
73-
allowedToPassTimeout: true, // true by default
74-
},
75-
};
76-
```
77-
78-
If you want to disable telemetry, set the `telemetry` field to `false`.
79-
80-
#### Disabling telemetry collection example
81-
82-
```typescript
83-
import { Config } from 'trello.js';
84-
85-
const config: Config = {
86-
key: 'YOUR_API_KEY',
87-
token: 'YOUR_API_TOKEN',
88-
telemetry: false, // Telemetry will not be collected
89-
};
90-
```
91-
9243
## Usage
9344

9445
#### Key and token pair issuing

0 commit comments

Comments
 (0)