@vechain/connex - npm Package Compare versions

Comparing version 0.5.0 to 0.6.0

index.d.ts

@@ -534,3 +534,3 @@ /**
             type TxResponse = {
-                txId: string
+                txid: string
                 signer: string
@@ -537,0 +537,0 @@ }

package.json

 {
   "name": "@vechain/connex",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Standard interface to connect DApp with VeChain and user",
@@ -5,0 +5,0 @@ "main": "",

README.md

@@ -1,6 +0,54 @@
-# Connex
+# Connex [![Gitter](https://badges.gitter.im/vechain/thor.svg)](https://gitter.im/vechain/thor?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
 
-Connex is the standard interface to connect DApp with VeChain and user.
+[![npm version](https://badge.fury.io/js/%40vechain%2Fconnex.svg)](https://badge.fury.io/js/%40vechain%2Fconnex)
 
-# Getting Started
+## Introduction
 
+Connex is the standard interface to connect DApp with VeChain and user. `Connex` is a set of well-designed APIs for developers, with injected `Connex Object` in web applications they can easily build decentralized applications.
+
+## Get Started 
+
+[Sync](https://github.com/vechain/thor-sync.electron/releases) or other compatible clients will expose `connex` API by an injected object on `Window Object`.
+
+### TypeScript(Recommended)
+
+``` bash
+npm install @vechain/connex --save-dev
+```
+
+Add `@vechain/connex` to `compilerOptions.types`  in `tsconfig.json` then you are good to go!
+
+### Vanilla JS
+
+No need to set up, just code in your favourite way.
+
+## Usage
+
+``` javascript
+const el = document.createElement('h1')
+if(window.connex){
+    const status = connex.thor.status
+    el.innerText = 'You are \'connexed\' to vechain, the status is ' + (status.progress === 1 ? 'synced': 'syncing')
+}else{
+    el.innerText = ':( seems you don\'t have enough component to launch this app, please ......'
+}
+document.querySelector('body').append(el)
+```
+
+## Developers
+
++ [API Reference](https://vechain.github.io/connex) for DApp developers
+
+## Architecture explained
+
+![Connex Architecture](./docs/architecture.png)
+
+## Compatible clients
+
++ [VeChain Sync](https://github.com/vechain/thor-sync.electron)
+
+## License
+
+Connex is licensed under the
+[GNU Lesser General Public License v3.0](https://www.gnu.org/licenses/lgpl-3.0.html), also included
+in *LICENSE* file in the repository.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

23854

increased by7.45%

Number of lines in readme file

54

increased by671.43%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes