![\"Circular](\"assets/logo.svg\"){kind=logo}
\n\n \n
\n Algorand provider is an interface that bridges the gap between dApps and wallets, allowing dApps to connect, and interact, with wallets in a standardized way.\n
\n\n### Table of contents\n\n* [1. Installation](#-1-installation)\n* [2. Documentation](#-2-documentation)\n* [3. Development](#-3-development)\n * [3.1. Requirements](#31-requirements)\n * [3.2. Setup](#32-setup)\n * [3.3. Build](#33-build)\n* [4. Appendix](#-4-appendix)\n * [4.1. Useful Information](#41-useful-information)\n * [4.2. Useful Commands](#42-useful-commands)\n* [5. How To Contribute](#-5-how-to-contribute)\n* [6. License](#-6-license)\n* [7. Credits](#-7-credits)\n\n## 📦 1. Installation\n\n* Using npm:\n```shell\nnpm install @agoralabs-sh/algorand-provider\n```\n\n* Using yarn:\n```shell\nyarn add @agoralabs-sh/algorand-provider\n```\n\n## 📚 2. Documentation\n\nFor full documentation, please see [here][documentation].\n\n[Back to top ^][table-of-contents]\n\n## 🛠 3. Development\n\n### 3.1. Requirements\n\n* Install [Yarn v1.22.5+][yarn]\n\n[Back to top ^][table-of-contents]\n\n### 3.2. Setup\n\n1. Install the dependencies:\n```bash\n$ yarn install\n```\n\n[Back to top ^][table-of-contents]\n\n### 3.3. Build\n\n* To build simply run:\n```bash\n$ yarn build\n```\n\nThis will compile the Typescript source code into a `dist/` directory.\n\n[Back to top ^][table-of-contents]\n\n## 📑 4. Appendix\n\n### 4.1. Useful Information\n\n* [ARC-0001][arc-0001]: the direction of the code leans heavily on what this ARC suggests and is in reality an extension of this ARC.\n\n[Back to top ^][table-of-contents]\n\n### 4.2. Useful Commands\n\n| Commnad | Description |\n|-----------------------|------------------------------------------------------------------------------------|\n| `yarn build` | Builds the source code into the `dist/` directory. |\n| `yarn run docs:build` | Builds the documentation into the `.docs/` directory. |\n| `yarn run docs:serve` | Serves the built documentation from the `.docs/` directory. |\n| `yarn run docs:start` | Builds and runs the documentation in a development environment with hot reloading. |\n| `yarn run lint` | Runs the linter on `.js` and `.ts` files. |\n| `yarn run prettier` | Runs the prettier on `.js` and `.ts` files. |\n| `yarn test` | Runs the tests. |\n\n[Back to top ^][table-of-contents]\n\n## 👏 5. How To Contribute\n\nPlease read the [**Contributing Guide**][contribute] to learn about the development process.\n\n[Back to top ^][table-of-contents]\n\n## 📄 6. License\n\nPlease refer to the [LICENSE][license] file.\n\n[Back to top ^][table-of-contents]\n\n## 🎉 7. Credits\n\n...TBC\n\n[Back to top ^][table-of-contents]\n\n\n[arc-0001]: https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0001.md\n[contribute]: ./CONTRIBUTING.md\n[documentation]: https://algorand-provider.agoralabs.sh\n[license]: ./LICENSE\n[table-of-contents]: #table-of-contents\n[yarn]: https://yarnpkg.com/\n","readmeFilename":"README.md"}![\"Build,](\"https://github.com/agoralabs-sh/algorand-provider/actions/workflows/lint_build_test.yml/badge.svg\"){kind=icon}
\n ![\"Build](\"https://github.com/agoralabs-sh/algorand-provider/actions/workflows/build_documentation.yml/badge.svg\"){kind=icon}
\n ![\"npm\"](\"https://img.shields.io/npm/v/@agoralabs-sh/algorand-provider\")
\n