Skip to content

Commit

Permalink
fix: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
fabiorigam committed Aug 30, 2024
1 parent 4471337 commit 5c1909a
Showing 1 changed file with 24 additions and 21 deletions.
45 changes: 24 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
<div align="center">
<h1><code>vechain-dapp-kit</code></h1>
<p>
<strong>A TypeScript library that facilitates seamless interaction between VeChain wallets.</strong>
</p>
<p>
<a href="https://sonarcloud.io/project/overview?id=vechain_vechain-dapp-kit"><img src="https://sonarcloud.io/api/project_badges/measure?project=vechain_vechain-dapp-kit&metric=alert_status&token=69ceb851539382455c3eba073d1690bb58147af5" alt="Quality Gate Status"></a>
<a href="https://sonarcloud.io/project/overview?id=vechain_vechain-dapp-kit"><img src="https://sonarcloud.io/api/project_badges/measure?project=vechain_vechain-dapp-kit&metric=security_rating&token=69ceb851539382455c3eba073d1690bb58147af5" alt="Security Rating"></a>
<a href="https://sonarcloud.io/project/overview?id=vechain_vechain-dapp-kit"><img src="https://sonarcloud.io/api/project_badges/measure?project=vechain_vechain-dapp-kit&metric=sqale_rating&token=69ceb851539382455c3eba073d1690bb58147af5" alt="Maintainability Rating"></a>
<a href="https://github.com/vechain/vechain-dapp-kit/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License: MIT"></a>
</p>
</div>

## 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

Expand All @@ -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.

---

Expand Down Expand Up @@ -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.

---
Expand Down

0 comments on commit 5c1909a

Please sign in to comment.