diff --git a/README.md b/README.md index 6abf2c4e596..aa8d157eed9 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,20 @@ This is the `anoma-apps` monorepo. Within it, you will find the following packag ```bash anoma-apps/ ├── packages/ -│ ├── anoma-wallet # Main wallet React App -│ ├── anoma-lib # Rust lib for generating WASM -│ └── key-management # Key management library +│ ├── anoma-wallet/ # Main wallet React App +│ ├── anoma-lib/ # Rust lib for generating WASM +│ └── key-management/ # Key management library ``` +## Usage + +Initialize `yarn` by issuing the following command: + +```bash +# First run this command in the root directory of anoma-apps/: +yarn +``` + +Each package in the repo will have its own set of `yarn` scripts. + More documentation _TBD_ diff --git a/packages/anoma-wallet/README.md b/packages/anoma-wallet/README.md index e6c403e946e..3752fbbf213 100644 --- a/packages/anoma-wallet/README.md +++ b/packages/anoma-wallet/README.md @@ -47,8 +47,8 @@ yarn wasm:build:nodejs ## Overview ```bash -# Directory structure rough outline for anoma-apps monorepo -. +# Directory structure rough outline for anoma-wallet +./src ├── App # Main React app and layouts ├── components # React Components ├── constants @@ -57,10 +57,14 @@ yarn wasm:build:nodejs │ └── wasm.ts # Wasm source constants ├── lib │ ├── rpc -│ │ ├── RpcClient.ts # RPC HTTP and WebSocket library -│ │ ├── types.ts # RPC Request/Response types -│ └── tx -│ └── Transfer.ts # Transfer transaction library +│ │ ├── RpcClient.ts # RPC HTTP library +│ │ ├── SocketClient.ts # RPC WebSocket library +│ │ └── types.ts # RPC Request/Response types +│ ├── tx +│ │ ├── Transfer.ts # Transfer transaction library +│ │ └── Account.ts # Account transaction library +│ ├── Keypair.ts # Keypair library +│ └── Wallet.ts # Wallet library ├── schema # Borsh schema for deserializing abci_query types └── utils ├── helpers # Utility helper functions