Skip to content

Commit

Permalink
Improve documentation for encrypted notes examples (#617)
Browse files Browse the repository at this point in the history
  • Loading branch information
fspreiss authored Sep 19, 2023
1 parent d0157c4 commit 5f86dc5
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
8 changes: 7 additions & 1 deletion motoko/encrypted-notes-dapp-vetkd/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,16 @@ Please also see the [README of the original encrypted-notes-dapp](../encrypted-n
This example uses an [**insecure** implementation](../../rust/vetkd/src/system_api) of [the proposed vetKD system API](https://github.com/dfinity/interface-spec/pull/158) in a pre-compiled form via the [vetkd_system_api.wasm](./vetkd_system_api.wasm). **Do not use this in production or for sensitive data**! This example is solely provided **for demonstration purposes** to collect feedback on the mentioned vetKD system API.

## Manual local deployment
1. For **Motoko** deployment set environmental variable:
1. Choose which implementation to use by setting a respective environment variable. You can choose Motoko or Rust.

For **Motoko** deployment use
```sh
export BUILD_ENV=motoko
```
For **Rust** deployment use
```sh
export BUILD_ENV=rust
```
2. To generate `$BUILD_ENV`-specific files (i.e., Motoko or Rust) run:
```sh
sh ./pre_deploy.sh
Expand Down
6 changes: 1 addition & 5 deletions motoko/encrypted-notes-dapp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,11 +121,7 @@ Follow the steps below to deploy this sample project.
cd examples/motoko/encrypted-notes-dapp
```

or

```
cd examples/rust/encrypted-notes-dapp
```
This project folder contains the files for both Motoko and Rust development.

### Step 2: Set an environmental variable reflecting which backend canister you'll be using:
For Motoko deployment run:
Expand Down

0 comments on commit 5f86dc5

Please sign in to comment.