Skip to content

Minor changes to Protect.js README #107

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

Merged
kateandrews merged 1 commit into from
Mar 12, 2025
Merged

Minor changes to Protect.js README #107

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
12 changes: 5 additions & 7 deletions packages/protect/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,6 @@

<!-- start -->

## What's Protect.js?

Protect.js is a TypeScript package for encrypting and decrypting data.
Encryption operations happen directly in your app, and the ciphertext is stored in your database.

Expand All @@ -50,7 +48,7 @@ The encrypted data is structured as an [EQL](https://github.com/cipherstash/encr
- [Example applications](#example-applications)
- [Installing Protect.js](#installing-protectjs)
- [Getting started](#getting-started)
- [Identity-aware encryption](#identity-aware-decryption)
- [Identity-aware encryption](#identity-aware-encryption)
- [Bulk encryption and decryption](#bulk-encryption-and-decryption)
- [Supported data types](#supported-data-types)
- [Searchable encryption](#searchable-encryption)
Expand All @@ -60,7 +58,7 @@ The encrypted data is structured as an [EQL](https://github.com/cipherstash/encr
- [Contributing](#contributing)
- [License](#license)

For more specific documentation, please refer to the [docs](https://github.com/cipherstash/protectjs/tree/main/docs).
For more specific documentation, refer to the [docs](https://github.com/cipherstash/protectjs/tree/main/docs).

## Features

Expand All @@ -79,7 +77,7 @@ This enables every encrypted value, in every column, in every row in your databa

**Use cases:**
- **Trusted data access**: make sure only your end-users can access their sensitive data stored in your product.
- **Meet compliance requirements faster:** achieve and exceed the data encryption requirements of SOC2 and ISO27001.
- **Meet compliance requirements faster:** meet and exceed the data encryption requirements of SOC2 and ISO27001.
- **Reduce the blast radius of data breaches:** limit the impact of exploited vulnerabilities to only the data your end-users can decrypt.

## Example applications
Expand Down Expand Up @@ -141,15 +139,15 @@ To set up all the configuration and credentials required for Protect.js:
stash setup
```

If you have not already signed up for a CipherStash account, this will prompt you to do so along the way.
If you haven't already signed up for a CipherStash account, this will prompt you to do so along the way.

At the end of `stash setup`, you will have two files in your project:

- `cipherstash.toml` which contains the configuration for Protect.js
- `cipherstash.secret.toml`: which contains the credentials for Protect.js

> [!WARNING]
> `cipherstash.secret.toml` should not be committed to git, because it contains sensitive credentials.
> Don't commit `cipherstash.secret.toml` to git; it contains sensitive credentials.
> The `stash setup` command will attempt to append to your `.gitignore` file with the `cipherstash.secret.toml` file.

You can read more about [configuration via toml file or environment variables here](./docs/reference/configuration.md).
Expand Down