Skip to content

Commit

Permalink
Add "Run as a Safe app" to the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
germartinez authored Sep 2, 2020
1 parent 17bd62d commit 7022ec3
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -324,6 +324,16 @@ Run the tests against the local network:
yarn test
```

## Run your app as a Safe App

*CPK* uses the [Safe Apps SDK](https://github.com/gnosis/safe-apps-sdk), making your app available to be run in an iframe inside the [Safe Web UI](https://gnosis-safe.io/).

Once your app is ready to be deployed make sure to follow these [steps to run your app as a Safe app](https://github.com/gnosis/safe-apps-sdk#testing-in-the-safe-multisig-application). Apart from that, no extra configuration is needed.

When running your app inside the *Safe Web UI*, the configuration used to instantiate the *CPK* will be ignored because the responsability to send transactions is now tranferred to the *Safe Web UI* and the wallet connected to it.

If needed, the method `CPK.isSafeApp()` is available to check if the app using the *CPK* is running as a Safe app or not.

## In-depth Guide

The Contract Proxy Kit operates primarily using the following technologies:
Expand Down

0 comments on commit 7022ec3

Please sign in to comment.