plutosdk 0.0.8-beta.1

package/README.md

@@ -0,0 +1,77 @@
+# Pluto SDK for Telegram
+
+# Getting started 
+
+## Add the configuration required by sdk, and installation telegram web app sdk with cdn.
+Add the script to your HTML file:
+```html
+<meta name="viewport" content="initial-scale=1, width=device-width" />
+<meta name="theme-color" content="#000000" />
+<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,500,700&display=swap" />
+<script src="https://telegram.org/js/telegram-web-app.js"></script>
+```
+
+## Installation pluto sdk with cdn
+Add the script inside the body tag of your HTML file:
+```html
+<script src="https://unpkg.com/plutosdk@latest/dist/pluto-sdk.js"></script>
+```
+
+ℹ️ If you don't want auto-update the library, pass concrete version instead of `latest`, e.g.
+```html
+<script src="https://unpkg.com/plutosdk@0.0.1/dist/pluto-sdk.js"></script>
+```
+
+# Usage
+
+You can use global variable `PlutoSDK`
+
+## init
+```js
+PlutoSDK.init()
+```
+It returns a promise that resolves after init success.
+
+## login
+```js
+PlutoSDK.login()
+```
+It returns a promise that resolves after login success.
+
+## ready
+```js
+PlutoSDK.ready()
+```
+This method is called after login is complete. Call this method at the appropriate time to notify the SDK to delete the loading animation.
+
+## share
+```js
+PlutoSDK.share()
+```
+This method is shared in telegram.
+
+## purchase
+```js
+PlutoSDK.purchase(name, orderId, amount, customData, callback)
+```
+This method accepts the `name orderId amount customData callback` as parameters. `customData` and `callback` are optional parameters. 
+Please note that the this pointer of the callback method `callback` will be changed.
+
+## connectWallet
+```js
+PlutoSDK.connectWallet()
+```
+This method is to link the user's wallet. It returns a promise that resolves after wallet connected.
+
+## disconnectWallet
+```js
+PlutoSDK.disconnectWallet()
+```
+This method is to disconnect the user's connected wallet.
+
+## getWalletConnected
+```js
+PlutoSDK.getWalletConnected()
+```
+This method is to get whether the wallet is connected.
+