Skip to content

Commit

Permalink
Additional basic documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jurevans committed Mar 18, 2022
1 parent 149d40e commit 49f4490
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 9 deletions.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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_
16 changes: 10 additions & 6 deletions packages/anoma-wallet/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down

0 comments on commit 49f4490

Please sign in to comment.