Skip to content

Commit

Permalink
docs: refining readme
Browse files Browse the repository at this point in the history
  • Loading branch information
aorumbayev committed Dec 5, 2023
1 parent ebac55d commit 5691d30
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,16 @@
<a href="https://github.com/algorandfoundation/algokit-cli"><img src="https://img.shields.io/badge/Powered by-AlgoKit-black.svg" /></a>
</p>

<!-- <br />
<pre>npm i <a href="https://www.npmjs.com/package/react-use">react-use</a></pre>
<br /> -->

---

This template is a starter template for building an Algorand based dApp on React with [`subtopia-js-sdk`](https://github.com/subtopia-algo/subtopia-js) integration. The template is based on the official [`algokit-react-template`](https://github.com/algorandfoundation/algokit-react-frontend-template).

To get started execute the following command:

```shell
algokit init --template-url https://github.com/subtopia-algo/algokit-subtopia-template
```

## Features

The template offers two presets, the recommended preset includes all of the features included in the official [algokit-react-frontend-template](https://github.com/algorandfoundation/algokit-react-frontend-template), a custom preset allows you to select which features you want to include in your project.
Expand Down

0 comments on commit 5691d30

Please sign in to comment.