forked from cerc-io/laconic-wallet
Fix README (#114)
* Fix readme * Remove fullstops and colons * Don't link .env
This commit is contained in:
parent
b05b5894b0
commit
820ac62615
30
README.md
30
README.md
@ -55,7 +55,7 @@
|
|||||||
echo $ANDROID_HOME
|
echo $ANDROID_HOME
|
||||||
```
|
```
|
||||||
|
|
||||||
- and that the appropriate directories have been added to your path by running
|
- Check that the appropriate directories have been added to your path by running
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
echo $PATH
|
echo $PATH
|
||||||
@ -63,19 +63,19 @@
|
|||||||
|
|
||||||
## Setup for laconic-wallet
|
## Setup for laconic-wallet
|
||||||
|
|
||||||
1. Clone this repository:
|
1. Clone the repository
|
||||||
|
|
||||||
```
|
```
|
||||||
git clone git@git.vdb.to:cerc-io/laconic-wallet.git
|
git clone git@git.vdb.to:cerc-io/laconic-wallet.git
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Enter the project directory:
|
2. Enter the project directory
|
||||||
|
|
||||||
```
|
```
|
||||||
cd laconic-wallet
|
cd laconic-wallet
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Install the dependencies:
|
3. Install dependencies
|
||||||
|
|
||||||
```
|
```
|
||||||
yarn
|
yarn
|
||||||
@ -88,17 +88,17 @@
|
|||||||
cp .env.example .env
|
cp .env.example .env
|
||||||
```
|
```
|
||||||
|
|
||||||
- In [.env](./.env) file add WalletConnect project id. You can generate your own ProjectId at https://cloud.walletconnect.com
|
- In the `.env` file add your WalletConnect project id. You can generate your own ProjectId at https://cloud.walletconnect.com
|
||||||
|
|
||||||
```
|
```
|
||||||
WALLET_CONNECT_PROJECT_ID=39bc93c...
|
WALLET_CONNECT_PROJECT_ID=39bc93c...
|
||||||
```
|
```
|
||||||
|
|
||||||
5. Set up the Android device:
|
5. Set up the Android device
|
||||||
|
|
||||||
- For a physical device, refer to the [React Native documentation for running on a physical device](https://reactnative.dev/docs/running-on-device)
|
- For a physical device, refer to the [React Native documentation for running on a physical device](https://reactnative.dev/docs/running-on-device)
|
||||||
|
|
||||||
- For a virtual device, continue with the steps.
|
- For a virtual device, continue with the steps
|
||||||
|
|
||||||
6. Start the application
|
6. Start the application
|
||||||
|
|
||||||
@ -110,19 +110,19 @@
|
|||||||
|
|
||||||
## Setup for signature-requester-app
|
## Setup for signature-requester-app
|
||||||
|
|
||||||
1. Clone the repository:
|
1. Clone the repository
|
||||||
|
|
||||||
```
|
```
|
||||||
git clone git@git.vdb.to:cerc-io/signature-requester-app.git
|
git clone git@git.vdb.to:cerc-io/signature-requester-app.git
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Enter the project directory:
|
2. Enter the project directory
|
||||||
|
|
||||||
```
|
```
|
||||||
cd signature-requester-app
|
cd signature-requester-app
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Install the dependancies
|
3. Install dependencies
|
||||||
```
|
```
|
||||||
yarn
|
yarn
|
||||||
```
|
```
|
||||||
@ -133,7 +133,7 @@
|
|||||||
```
|
```
|
||||||
5. Press `a` to run the application on android
|
5. Press `a` to run the application on android
|
||||||
|
|
||||||
You should see both the apps running on your emulator or physical device.
|
You should see both the apps running on your emulator or physical device
|
||||||
|
|
||||||
## Flow for the app
|
## Flow for the app
|
||||||
|
|
||||||
@ -149,16 +149,16 @@ You should see both the apps running on your emulator or physical device.
|
|||||||
|
|
||||||
- On accepting, wallet sends the [namespaces](https://docs.walletconnect.com/advanced/glossary#namespaces) object with information about the accounts that are present in the wallet in response
|
- On accepting, wallet sends the [namespaces](https://docs.walletconnect.com/advanced/glossary#namespaces) object with information about the accounts that are present in the wallet in response
|
||||||
|
|
||||||
- Once [session](https://docs.walletconnect.com/advanced/glossary#session) is established, it is shown in the active sessions page
|
- Once the [session](https://docs.walletconnect.com/advanced/glossary#session) is established, it is shown on the active sessions page
|
||||||
|
|
||||||
- In this way, wallet can connect to multiple dApps
|
- The wallet can be connected to multiple dApps
|
||||||
|
|
||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
|
|
||||||
- To clean the buid
|
- To clean the build
|
||||||
|
|
||||||
```
|
```
|
||||||
cd adroid
|
cd android
|
||||||
|
|
||||||
./gradlew clean
|
./gradlew clean
|
||||||
```
|
```
|
||||||
|
Loading…
Reference in New Issue
Block a user