Add basic directory structure in readme file

This commit is contained in:
Georges KABBOUCHI 2021-08-14 00:26:56 +03:00
parent 0bfcc75070
commit 5dda11eb87

View File

@ -2,6 +2,29 @@
<img src="https://raw.githubusercontent.com/Instadapp/assembly/master/banner.png">
## Directory Structure
.
├── ...
├── composables
│ ├── protocols/ # Logic for protocols, example `useAave2Position.ts`
│ ├── ...
│ └── ...
├── ...
├── components
│ ├── protocols/ # Contains components used for protocols, example `CardAave.vue`
│ ├── sidebar/ # Contains all sidebar components, check `useSidebar.ts`
│ └── ...
├── ...
├── pages
│ ├── mainnet/ # Apps for Mainnet network
│ ├── polygon/ # Apps for Polygon network
│ └── index.vue # List all avaiable apps
└── ...
## Development
```bash
# install dependencies
$ yarn install