Skip to content

Commit 39c00f4

Browse files
committed
docs: Added docs readme
1 parent b85da30 commit 39c00f4

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

docs/README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# AlgoKit TypeScript Utilities
2+
3+
A set of core Algorand utilities written in TypeScript and released via npm that make it easier to build solutions on Algorand. This project is part of [AlgoKit](https://github.com/algorandfoundation/algokit-cli).
4+
5+
The goal of this library is to provide intuitive, productive utility functions that make it easier, quicker and safer to build applications on Algorand. Largely these functions wrap the underlying Algorand SDK, but provide a higher level interface with sensible defaults and capabilities for common tasks.
6+
7+
Note: If you prefer Python there's an equivalent [Python utility library](https://github.com/algorandfoundation/algokit-utils-py).
8+
9+
# Install documentation
10+
11+
This library can be installed from NPM using your favourite npm client, e.g.:
12+
13+
```
14+
npm install @algorandfoundation/algokit-utils
15+
```
16+
17+
# Code documentation
18+
19+
We have [auto-generated documentation for the code](code/README.md).

0 commit comments

Comments
 (0)