Skip to content

Commit

Permalink
Merge pull request #42 from akanoce/chore-react-v3-docs
Browse files Browse the repository at this point in the history
chore(sdk/readme): add toc
  • Loading branch information
akanoce authored Jun 9, 2024
2 parents 8125f6a + 53bd09c commit f404e7e
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 1 deletion.
41 changes: 41 additions & 0 deletions packages/aave-v3-react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,33 @@
![npm bundle size](https://img.shields.io/bundlephobia/min/aave-v3-react)
![npm](https://img.shields.io/npm/dm/aave-v3-react)

<!-- TOC --><a name="overview"></a>

## Overview

`aave-v3-react` is a React SDK that makes creating a dApp on top of the Aave Protocol V3 feeling like a breeze. We offer a full suite of hooks and providers integrated with `wagmi` and `viem` to make devs life easier.

<!-- TOC start (generated with https://github.com/derlin/bitdowntoc) -->

- [Aave V3 React](#aave-v3-react)
- [Overview](#overview)
- [Features](#features)
- [Installation](#installation)
- [Note on the additional packages](#note-on-the-additional-packages)
- [Quick start](#quick-start)
- [About Next.js](#about-nextjs)
- [React native](#react-native)
- [API Reference](#api-reference)
- [Future of the project](#future-of-the-project)
- [Contributing](#contributing)
- [Acknowledgments](#acknowledgments)

<!-- TOC end -->

<!-- TOC --><a name="aave-v3-react"></a>

<!-- TOC --><a name="features"></a>

## Features

- (Almost) full integration with the Aave Protocol V3
Expand All @@ -19,6 +42,8 @@
- Comprehensive TypeScript support
- Next.js and Vite example apps

<!-- TOC --><a name="installation"></a>

## Installation

After having setting up a react project with [vite](https://vitejs.dev/guide/) or [next.js](https://nextjs.org/docs/getting-started/installation)
Expand All @@ -35,6 +60,8 @@ or
yarn add aave-v3-react @tanstack/react-query wagmi viem@2.x connectkit @tanstack/react-query-devtools
```

<!-- TOC --><a name="note-on-the-additional-packages"></a>

### Note on the additional packages

aave-v3-react depends on `@tanstack/react-query`, `wagmi` and `viem`. If any of those packages is missing or installed with an unsupported version, it's possible you experience errors like:
Expand All @@ -44,6 +71,8 @@ aave-v3-react depends on `@tanstack/react-query`, `wagmi` and `viem`. If any of

If this is the case, please double check the version of the packages before opening an issue.

<!-- TOC --><a name="quick-start"></a>

## Quick start

if you have installed all the packages above, you can spin up your project quickly with the following structure:
Expand Down Expand Up @@ -146,14 +175,20 @@ export const App = () => {
}
```

<!-- TOC --><a name="about-nextjs"></a>

### About Next.js

`aave-v3-react` is fully complatible with next.js, but you may experience some issues with `wagmi` and `connectkit` in some cases. Make sure to add the `"use client";` directive where needed, and eventually check their docs to tackle such errors.

<!-- TOC --><a name="react-native"></a>

### React native

React native support is still unexplored but should work out of the box. In case you managed to integrate the library there correctly, please open a PR documenting that and possibly providing an example app.

<!-- TOC --><a name="api-reference"></a>

## API Reference

Full API reference is coming soon.
Expand All @@ -168,6 +203,8 @@ Also, a few methods like

have been fully integrated in the [example apps](https://github.com/akanoce/react-aave-sdk/tree/main/apps).

<!-- TOC --><a name="future-of-the-project"></a>

## Future of the project

`aave-v3-react` is a reactive wrapper on top of [aave-utilities](https://github.com/aave/aave-utilities), in the short/mid term we aim to:
Expand All @@ -179,11 +216,15 @@ Also, a few methods like
- Investigate react-native support
- Add more examples

<!-- TOC --><a name="contributing"></a>

## Contributing

Contributing guidlines are coming soon.
If you want to contribute to this project, open an issue, PR or write me on X ([@ErikNucibella](https://x.com/ErikNucibella))

<!-- TOC --><a name="acknowledgments"></a>

## Acknowledgments

- [Aave Protocol](https://aave.com/)
Expand Down
2 changes: 1 addition & 1 deletion packages/aave-v3-react/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "aave-v3-react",
"version": "1.0.6",
"version": "1.0.7",
"private": false,
"description": "A collection of React hooks to interact with the Aave V3 pools and smart contracts.",
"repository": "git@github.com:akanoce/react-aave-sdk.git",
Expand Down

0 comments on commit f404e7e

Please sign in to comment.