Skip to content

Commit c6dc7d5

Browse files
committed
docs: refactor main readme
1 parent a645115 commit c6dc7d5

File tree

1 file changed

+11
-35
lines changed

1 file changed

+11
-35
lines changed

README.md

Lines changed: 11 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,18 @@
22
<a href="https://cipherstash.com">
33
<img alt="CipherStash Logo" loading="lazy" width="128" height="128" decoding="async" data-nimg="1" style="color:transparent" src="https://cipherstash.com/assets/cs-github.png">
44
</a>
5-
<h1>CipherStash Stack</h1>
5+
<h1>Data secruity Stack for TypeScript</h1>
66

77
<a href="https://cipherstash.com"><img alt="Built by CipherStash" src="https://raw.githubusercontent.com/cipherstash/meta/refs/heads/main/csbadge.svg?style=for-the-badge&labelColor=000"></a>
88
<a href="https://github.com/cipherstash/protectjs/blob/main/LICENSE.md"><img alt="License" src="https://img.shields.io/npm/l/@cipherstash/protect.svg?style=for-the-badge&labelColor=000000"></a>
9+
<a href="https://cipherstash.com/docs"><img alt="Docs" src="https://img.shields.io/badge/Docs-000000.svg?style=for-the-badge&logo=readthedocs&labelColor=000000"></a>
910
<a href="https://discord.gg/5qwXUFb6PB"><img alt="Join the community on Discord" src="https://img.shields.io/badge/Join%20the%20community-blueviolet.svg?style=for-the-badge&logo=Discord&labelColor=000000&logoWidth=20"></a>
1011

1112
</div>
1213

1314
Field-level encryption for TypeScript apps with searchable encrypted queries, zero-knowledge key management, and first-class ORM support. Manage secrets with end-to-end encryption, using the CipherStash [Secrets](https://cipherstash.com/docs/secrets) API.
1415

15-
## Quick example
16+
## Quick Encryption example
1617

1718
```typescript
1819
import { Encryption } from "@cipherstash/stack";
@@ -77,38 +78,9 @@ CS_CLIENT_ACCESS_KEY= # API key for CipherStash API
7778

7879
## Integrations
7980

80-
### Drizzle
81-
82-
Define encrypted columns directly in your Drizzle schema with auto-encrypting query operators:
83-
84-
```typescript
85-
import { encryptedType, createEncryptionOperators } from "@cipherstash/stack/drizzle";
86-
const encryptionOps = createEncryptionOperators(encryptionClient);
87-
```
88-
89-
[Drizzle integration docs →](./docs/reference/drizzle/drizzle.md)
90-
91-
### Supabase
92-
93-
Encrypted queries that look like normal Supabase queries:
94-
95-
```typescript
96-
import { encryptedSupabase } from "@cipherstash/stack/supabase";
97-
const eSupabase = encryptedSupabase({ encryptionClient: client, supabaseClient: supabase });
98-
```
99-
100-
[Supabase integration docs →](./docs/reference/supabase-sdk.md)
101-
102-
### DynamoDB
103-
104-
Transparent encryption for DynamoDB items with equality lookups:
105-
106-
```typescript
107-
import { encryptedDynamoDB } from "@cipherstash/stack/dynamodb";
108-
const dynamo = encryptedDynamoDB({ encryptionClient: client });
109-
```
110-
111-
[DynamoDB integration docs →](./docs/reference/dynamodb.md)
81+
- [Drizzle integration docs →](./docs/reference/drizzle/drizzle.md)
82+
- [Supabase integration docs →](./docs/reference/supabase-sdk.md)
83+
- [DynamoDB integration docs →](./docs/reference/dynamodb.md)
11284

11385
## Secrets
11486

@@ -117,9 +89,13 @@ Zero-trust secrets management with end-to-end encryption — plaintext never lea
11789
```typescript
11890
import { Secrets } from "@cipherstash/stack/secrets";
11991

92+
// 1. Initialize the secrets client
12093
const secrets = new Secrets({ environment: "production" });
12194

95+
// 2. Set a secret with the SDK or the CLI
12296
await secrets.set("DATABASE_URL", "postgres://user:pass@host:5432/db");
97+
98+
// 3. Consume the secret in your application
12399
const { data } = await secrets.get("DATABASE_URL");
124100
```
125101

@@ -139,7 +115,7 @@ const { data } = await secrets.get("DATABASE_URL");
139115

140116
## Contributing
141117

142-
Contributions to Protect.js are welcome and highly appreciated. However, before you jump right into it, we would like you to review our [Contribution Guidelines](CONTRIBUTE.md) to make sure you have a smooth experience contributing.
118+
Contributions are welcome and highly appreciated. However, before you jump right into it, we would like you to review our [Contribution Guidelines](CONTRIBUTE.md) to make sure you have a smooth experience contributing.
143119

144120
---
145121

0 commit comments

Comments
 (0)