Skip to content

docs: add security best practices for API keys #293

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

Open
EasterRobert wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add security best practices for API keys #293

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,13 @@

Typescript client for the Polymarket CLOB

### Security Best Practices

When using this client, please ensure:
- Never commit your `API_KEY` or `PRIVATE_KEY` to public repositories.
- Use environment variables (`.env` files) to store sensitive credentials.
- Add `.env` to your `.gitignore` file immediately.

### Usage

```ts
Expand Down