diff --git a/README.md b/README.md index 32e9f47..f69178c 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,23 @@ -# PostGuard example +#

PostGuard

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