Skip to content

Commit 522c55e

Browse files
authored
Security Disclaimer (#5)
* add security disclaimer * better text
1 parent 9ad1944 commit 522c55e

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ For example, a user queries the 'company' field with the text of 'goog' as a sea
2020
- [🔧 Installation](#installation)
2121
- [🚀 Usage](#usage)
2222
- [📘 Documentation](#documentation)
23+
- [🔒 Security Disclaimer](#security)
2324

2425
## 🔧 Installation <a name="installation"></a>
2526

@@ -100,3 +101,6 @@ Refer to the styles in this [css file](https://github.com/peopledatalabs/pdl-rea
100101
background-color: red !important;
101102
}
102103
```
104+
105+
## 🔒 Security Disclaimer <a name="security"></a>
106+
This library should be used as an internal tool or as a proof of concept as it fires off requests to the PDL Autocomplete API from the client. This is due to the nature of being a react component and API Keys being all encompassing at PDL. We highly suggest referencing the component's code base for spinning up your own version but accessing the PDL Autocomplete API via a proxy server and not using this in a public production environment.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "pdl-react-autocomplete",
3-
"version": "1.1.1",
3+
"version": "1.1.2",
44
"description": "A react component for the People Data Labs Autocomplete API",
55
"source": "src/index.ts",
66
"main": "dist/index.js",

0 commit comments

Comments
 (0)