docs: revamp docs

Author: calvinbrewer

README.md

@@ -0,0 +1,21 @@
+# dbdev
+
+We publish a Trusted Language Extension for PostgreSQL for use on [dbdev](https://database.dev/).
+You can find the extension on [dbdev's extension catalog](https://database.dev/cipherstash/eql).
+
+## Publishing
+
+**DISCLAIMER:** At the moment, we are manually publishing the extension to dbdev and the versions might not be in sync with the releases on GitHub until we automate this process.
+
+### Steps to publish
+
+> [!NOTE]
+> Make sure you have the [dbdev CLI](https://supabase.github.io/dbdev/cli/) installed and logged in using the `dbdev shared token` in 1Password.
+
+1. Run `mise run build` to build the extension which will create the following file in the `dbdev` directory. (Note: this release artifact is built from the Supabase release artifact).
+2. After the build is complete, you will have a file in the `dbdev` directory called `eql--0.0.0.sql`.
+3. Update the file name from `eql--0.0.0.sql` replacing `0.0.0` with the version number of the release.
+4. Also update the `eql.control` file with the new version number.
+5. Run `dbdev publish` to publish the extension to dbdev.
+
+Reach out to @calvinbrewer if you need help.

dbdev/README.md

@@ -0,0 +1,3 @@
+default_version = 2.0.2
+comment = 'Index and search encrypted data in PostgreSQL with SQL'
+relocatable = true

dbdev/eql.control

@@ -6,14 +6,12 @@ This directory contains the documentation for the Encrypt Query Language (EQL).
 
 - [Postgres data security with CipherStash](concepts/WHY.md)
 
-## How-to guides
+## Reference
 
-- [Getting started](tutorials/GETTINGSTARTED.md)
-- [Using CipherStash Proxy](tutorials/PROXY.md)
+- [EQL index configuration for CipherStash Proxy](reference/index-configuration.md)
+- [EQL with JSON and JSONB](reference/json-support.md)
+- [EQL payload data format](reference/eql-payload.md)
 
-## Reference
+## Tutorials
 
-- [EQL index configuration](reference/INDEX.md)
-- [EQL with JSON and JSONB](reference/JSON.md)
-- [CipherStash Migrator](reference/MIGRATOR.md)
-- [EQL payload data format](reference/PAYLOAD.md)
+- [CipherStash Proxy Configuration with EQL functions](tutorials/proxy-configuration.md)

docs/README.md

@@ -9,11 +9,11 @@ This page gives a high-level overview of CipherStash's encryption in use solutio
    - [Why use encryption in use?](#why-use-encryption-in-use)
 2. [CipherStash Proxy](#cipherstash-proxy)
    - [How it works](#how-it-works)
-3. [Encrypt Query Language (EQL)](#encrypt-query-language-eql)
-4. [Best practices](#best-practices)
-5. [Advanced topics](#advanced-topics)
-   - [Integrating without proxy](#integrating-without-proxy)
-6. [Conclusion](#conclusion)
+3. [Protect.js](#protectjs)
+   - [How it works](#how-it-works-1)
+4. [Encrypt Query Language (EQL)](#encrypt-query-language-eql)
+5. [Best practices](#best-practices)
+6. [Getting started](#getting-started)
 
 ## Encryption in use
 
@@ -52,41 +52,37 @@ This enables encryption in use without significant changes to your application c
 - **Encrypts data**: For write operations, it encrypts the plaintext data before sending it to the database.
 - **Decrypts data**: For read operations, it decrypts the encrypted data retrieved from the database before returning it to the client.
 - **Maintains searchability**: Ensures that the encrypted data is searchable and retrievable without sacrificing performance or application functionality.
-- **Manages encryption keys**: Securely handles encryption keys required for encrypting and decrypting data.
+
+## Protect.js
+
+Protect.js is an NPM package that provides a set of functions to encrypt and decrypt data.
+It is a client-side library that can be used to encrypt and decrypt data in your JS/TS application.
+
+### How it works
+
+- **Encrypts data**: Protect.js encrypts the plaintext data before sending it to the database.
+- **Decrypts data**: Protect.js decrypts the encrypted data retrieved from the database before returning it to the client.
+- **Maintains searchability**: Ensures that the encrypted data is searchable and retrievable without sacrificing performance or application functionality.
 
 ## Encrypt Query Language (EQL)
 
 Encrypt Query Language (EQL) is a set of PostgreSQL functions and data types provided by CipherStash to work with encrypted data and indexes.
 EQL allows you to perform queries on encrypted data without decrypting it, supporting operations like equality checks, range queries, and unique constraints.
 
-To get started, read the [Getting started](https://github.com/cipherstash/encrypt-query-language/blob/main/GETTINGSTARTED.md) guide.
-
 ## Best practices
 
-- **Use CipherStash Proxy** to handle encryption/decryption transparently.
 - **Use EQL functions** when interacting with encrypted data.
 - **Define database constraints**to maintain data integrity.
 - **Secure key management** of encryption keys.
 - **Monitor query performance** and optimize as needed.
 
-## Advanced topics
-
-### Integrating without CipherStash Proxy
-
-> The SDK approach is currently in development, but if you're interested in contributing, please start a discussion [here](https://github.com/cipherstash/encrypt-query-language/discussions).
-
-For advanced users who prefer to handle encryption within their application:
-
-- **SDKs available**: Use CipherStash SDKs (at the moment, Rust and TypeScript) to manage encryption/decryption.
-- **Manual encryption**: Implement encryption logic in your application code.
-- **Data conformity**: Ensure encrypted data matches the expected `jsonb` schema.
-- **Key management**: Handle encryption keys securely within your application.
-
-**Note**: This approach increases complexity and is recommended only if CipherStash Proxy does not meet specific requirements. 
-
 ## Getting started
 
-To get started using CipherStash's encryption is use solution, see the [Getting Started](https://github.com/cipherstash/encrypt-query-language/blob/main/GETTINGSTARTED.md) guide.
+Use one of the CipherStash integrations using EQL to get started.
+
+- [Protect.js](https://github.com/cipherstash/protectjs)
+- [CipherStash Proxy](https://github.com/cipherstash/proxy)
+- [Protect.php](https://github.com/cipherstash/protectphp)
 
 For further help, raise an issue [here](https://github.com/cipherstash/encrypt-query-language/issues).
 

docs/concepts/WHY.md

@@ -37,8 +37,6 @@ CipherStash Proxy will handle the plaintext payload and create the encrypted pay
 
 ## Data format
 
-The format is defined as a [JSON Schema](../../sql/schemas/cs_encrypted_v2.schema.json).
-
 It should never be necessary to directly interact with the stored `jsonb`.
 CipherStash Proxy handles the encoding, and EQL provides the functions.
 

docs/reference/MIGRATOR.md

@@ -1,4 +1,8 @@
-# EQL index configuration
+# EQL index configuration for CipherStash Proxy
+
+> [!NOTE]
+> This guide is for CipherStash Proxy.
+> If you are using Protect.js, see the [Protect.js schema](https://github.com/cipherstash/protectjs/blob/main/docs/reference/schema.md).
 
 The following functions allow you to configure indexes for encrypted columns.
 All these functions modify the `eql_v2_configuration` table in your database, and are added during the EQL installation.