Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
28 changes: 16 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,23 @@
# PostGuard example
# <p align="center"><img src="./img/pg_logo.svg" height="128px" alt="PostGuard" /></p>

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).

## 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
1 change: 1 addition & 0 deletions img/pg_logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.