@aptos-labs/js-pro 0.0.1

package/README.md

@@ -0,0 +1,50 @@
+# Aptos JS Pro
+
+Aptos JS Pro is a framework agnostic library of queries and mutations related to the Aptos ecosystem.
+
+# Getting Started
+
+1. Install the package
+
+```bash
+pnpm add @aptos-labs/js-pro 
+```
+
+2. Initialize the AptosJSPro client
+
+```ts
+const core = new AptosJSProClient({ account, network, signer });
+```
+
+3. You now have access to all of the queries and mutations in the library!
+
+```ts
+const address = await core.fetchAddressFromName({ name: 'kent.apt' })
+
+const signedTxn = await core.signTransaction({ rawTxn })
+```
+
+# Maintainers
+
+In order to see changes reflected in apps locally, the package needs to be built and bundled. To do this, run the following command from the project:
+
+```bash
+pnpm build
+```
+
+This will build the package and place it in the `dist` folder. The package builds to CommonJS and ESM.
+
+## Utilities
+
+Aptos core provides the client alongside the signer, network, and account. If you need access to clients such as the indexer client, FaucetClient, TokenClient, or AptosClient, you can use the `getClients()` utility.
+
+```ts
+// Access AptosClient via `provider.aptosClient`
+const { provider, indexerClient, faucetClient, tokenClient } = core.getClients();
+
+// Access to: core.account, core.network, core.signer
+core.account
+```
+
+> The AptosClient can be found in the provider client as `provider.aptosClient` in `getClients()`
+