diff --git a/README.md b/README.md index f05cc96..a83f3a6 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,73 @@ -# Libra Javascript SDK -Libra's Javascript SDK that can help developer easy to integrate web application with Libra payment in minutes. +

+ + +
+
+

-## Development +

Javascript SDK that can help developer easy to integrate web application with Libra payment in minutes.

-**Clone and install** -```bash -git clone git@github.com:atscaletech/libra-js.git +

+ Website • + Documentation +

-cd libra-js +
-yarn -``` +[![Lint](https://github.com/atscaletech/libra-js/actions/workflows/lint.yml/badge.svg)](https://github.com/atscaletech/libra-js/actions/workflows/lint.yml) +[![Test](https://github.com/atscaletech/libra-js/actions/workflows/test.yml/badge.svg)](https://github.com/atscaletech/libra-js/actions/workflows/test.yml) -## Run tests +
-```bash -yarn tests -``` +## Installation +### CDN -## Test with coverage +```html + +``` -```bash -yarn test:coverage +### Package manager +```js +nmp install @atscaletech/libra-sdk ``` +**or** +```js +yarn add @atscaletech/libra-sdk +``` +## Quick start + +```js +import { Libra } from 'libra-js'; -## Build +const libra = new Libra({ + appName: 'Libra Example', + rpc: 'wss://rpc.libra.atscale.xyz', +}); -```bash -yarn build +async function main() { + const ALICE_ADDRESS = '5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY'; + const BOB_ADDRESS = '5FHneW46xGXgs5mUiveU4sbTyGBzmstUspZC92UhjJM694ty'; + + const account = await libra.walletConnection.getAccount(ALICE_ADDRESS); + + const { hash, status } = await libra.lrp.createPayment({ + payee: BOB_ADDRESS, + amount: 1000, + currencyId: 'Native', + description: 'payment description', + receipt: 'payment receipt' + }, account); +} ``` +## Modules + +- [Wallet Connection](https://docs.thelibra.org/sdk/connect-wallet) +- [Payments](https://docs.thelibra.org//sdk/payments) +- [Currencies](https://docs.thelibra.org/sdk/currencies) +- [Disputes](https://docs.thelibra.org/sdk/disputes) +- [Resolvers Network](https://docs.thelibra.org/sdk/resolvers) +- [Identities](https://docs.thelibra.org/sdk/identities) + +## License + +[Apache-2.0](LICENSE)