Skip to content

Commit

Permalink
Add TOC to README
Browse files Browse the repository at this point in the history
  • Loading branch information
EridianAlpha committed Apr 18, 2024
1 parent d58aa31 commit 3b4adb8
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,26 @@
>
> ---
- [Overview](#overview)
- [Key Functions](#key-functions)
- [WebApp](#webapp)
- [Installation](#installation)
- [Clone repository](#clone-repository)
- [Install Dependencies](#install-dependencies)
- [Create `.env` file](#create-env-file)
- [Configure Ethernal (optional)](#configure-ethernal-optional)
- [Testing](#testing)
- [Tests](#tests)
- [Coverage](#coverage)
- [Deployment](#deployment)
- [Interactions](#interactions)
- [Deposit](#deposit)
- [Build and Deploy Documentation](#build-and-deploy-documentation)
- [License](#license)

## Overview

Docs: [https://eridianalpha.github.io/aave-position-manager](https://eridianalpha.github.io/aave-position-manager)
> Docs Site: [https://eridianalpha.github.io/aave-position-manager](https://eridianalpha.github.io/aave-position-manager)
A smart contract manager for Aave positions.

Expand Down Expand Up @@ -93,7 +110,7 @@ make coverage

Under development 🏗️

## Docs
## Build and Deploy Documentation

Instructions on how to build and deploy the documentation book are details here: [https://docs.eridianalpha.com/ethereum-dev/foundry-notes/docs-and-github-pages](https://docs.eridianalpha.com/ethereum-dev/foundry-notes/docs-and-github-pages)

Expand Down

0 comments on commit 3b4adb8

Please sign in to comment.