diff --git a/README.md b/README.md index 5c44918f1..7834846c4 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,27 @@ -# SDK for Aptos Node API +# Typescript SDK for Aptos [![Discord][discord-image]][discord-url] [![NPM Package Version][npm-image-version]][npm-url] [![NPM Package Downloads][npm-image-downloads]][npm-url] -The Aptos TypeScript SDK provides a convenient way to interact with the Aptos blockchain using TypeScript. It offers a set of utility functions, classes, and types to simplify the integration process and enhance developer productivity. +The Aptos TypeScript SDK provides a convenient way to interact with the Aptos blockchain using TypeScript. It offers a +set of utility functions, classes, and types to simplify the integration process and enhance developer productivity. + +This repository supports version >= 2.0.0 of the [Aptos SDK npm package](https://www.npmjs.com/package/aptos). ## Installation ##### For use in Node.js or a web application -```ts -pnpm install aptos +Install with your favorite package manager such as npm, yarn, or pnpm: +```bash +npm install aptos ``` -You can also use your preferred npm client, such as yarn or npm. - ##### For use in a browser -```ts +You can add the SDK to your web application using a script tag: +```html