diff --git a/README.md b/README.md index 53f45718..9f7257f6 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,20 @@ -# vechain-dapp-kit - -The Vechain DAppKit is a TypeScript library that facilitates seamless interaction between vechain wallets (veworld, sync2) -and dApps, enhancing user experience and developer convenience. Please refer to [Vechain Docs](https://docs.vechain.org/developer-resources/sdks-and-providers/dapp-kit) for full documentation and usage. +
+

vechain-dapp-kit

+

+ A TypeScript library that facilitates seamless interaction between VeChain wallets. +

+

+ Quality Gate Status + Security Rating + Maintainability Rating + License: MIT +

+
+ +## Introduction + +The VeChain DAppKit is a TypeScript library that facilitates seamless interaction between VeChain wallets (VeWorld, sync2) +and dApps, enhancing user experience and developer convenience. Please refer to [VeChain Docs](https://docs.vechain.org/developer-resources/sdks-and-providers/dapp-kit) for full documentation and usage. ## Table of Contents @@ -19,34 +32,24 @@ and dApps, enhancing user experience and developer convenience. Please refer to ## Why ? - Allow easy interaction with all wallets. -- Currently, connex only plays nice with Sync / Sync2 +- Currently, Connex only plays nice with Sync / Sync2 - Enable a better UX for users ## Key features -Key Features a.k.a scope - -1. wallet connectivity - - key components that handle interaction with veworld and sync 2 - -2. customizable UI - - ability to totally customize the UI of components - -3. User Experience +1. **Wallet Connectivity**: Key components that handle interaction with VeWorld and Sync 2. - Consistent experience with Ethereum and other chains +2. **Customizable UI**: Ability to totally customize the UI of components. -4. Developer friendly +3. **User Experience**: Consistent experience with Ethereum and other chains. - Easy to adopt with proper documentation. +4. **Developer friendly**: Easy to adopt with proper documentation. --- ## Contributing -- Please refer to the [Contributing Guide](./CONTRIBUTING.md) for more information on how to contribute to the project. +Please refer to the [Contributing Guide](./CONTRIBUTING.md) for more information on how to contribute to the project. --- @@ -163,7 +166,7 @@ yarn test:e2e:headless ## Further Documentation & Usage -- Please refer to [Vechain Docs](https://docs.vechain.org/developer-resources/sdks-and-providers) for more information +- Please refer to [VeChain Docs](https://docs.vechain.org/developer-resources/sdks-and-providers) for more information on how to use the library. ---