From 79c4874c268e7a505b3d7417e9e6805944a04e3e Mon Sep 17 00:00:00 2001 From: "dobby-yivi-agent[bot]" <275734547+dobby-yivi-agent[bot]@users.noreply.github.com> Date: Tue, 14 Apr 2026 09:36:30 +0000 Subject: [PATCH 1/3] Standardize README to match org-wide format Point to docs.postguard.eu for full documentation and restructure into the standard sections: description, development, releasing, license. Co-Authored-By: Claude Opus 4.6 --- README.md | 28 ++++++++++++++++------------ 1 file changed, 16 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 32e9f47..51000af 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,23 @@ -# PostGuard example +# pg-example -For a specific example on how to encrypt a string see -[examples/string.js](./examples/string.js). For an example of how to encrypt -files, see [examples/file.js](./examples/file.js). +> For full documentation, visit [docs.postguard.eu](https://docs.postguard.eu/repos/pg-example). -## Running the examples +Standalone example application for PostGuard file and string encryption using WASM bindings directly. This is a lower-level example that talks to the WASM layer without going through the `@e4a/pg-js` SDK, which makes it useful for understanding how the cryptographic bindings work under the hood. -Install the dependencies using: +## Development -``` -yarn +Requires Node.js and Yarn. Uses Webpack for bundling. + +```bash +yarn install +yarn dev # start dev server +yarn build # production build ``` -Then, run a development setup using: +## Releasing -``` -yarn dev -``` +No releases. This is example code. + +## License + +MIT From 3b262553834ed7da56cfbaf447f9a0664dc20c9c Mon Sep 17 00:00:00 2001 From: "dobby-yivi-agent[bot]" <275734547+dobby-yivi-agent[bot]@users.noreply.github.com> Date: Wed, 15 Apr 2026 09:41:44 +0000 Subject: [PATCH 2/3] Add PostGuard logo to README Co-Authored-By: Claude Opus 4.6 --- README.md | 2 +- img/pg_logo.svg | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) create mode 100644 img/pg_logo.svg diff --git a/README.md b/README.md index 51000af..27464a7 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# pg-example +#

PostGuard

> For full documentation, visit [docs.postguard.eu](https://docs.postguard.eu/repos/pg-example). diff --git a/img/pg_logo.svg b/img/pg_logo.svg new file mode 100644 index 0000000..34edeee --- /dev/null +++ b/img/pg_logo.svg @@ -0,0 +1 @@ + \ No newline at end of file From 0b9fef8f8870b0be0e9af8622c96eaaa3f458d28 Mon Sep 17 00:00:00 2001 From: "dobby-coder[bot]" <275734547+dobby-coder[bot]@users.noreply.github.com> Date: Wed, 15 Apr 2026 13:12:01 +0000 Subject: [PATCH 3/3] fix: update docs link to point to main docs site --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 27464a7..f69178c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ #

PostGuard

-> For full documentation, visit [docs.postguard.eu](https://docs.postguard.eu/repos/pg-example). +> For full documentation, visit [docs.postguard.eu](https://docs.postguard.eu). Standalone example application for PostGuard file and string encryption using WASM bindings directly. This is a lower-level example that talks to the WASM layer without going through the `@e4a/pg-js` SDK, which makes it useful for understanding how the cryptographic bindings work under the hood.