update readme

dl-tokene · Apr 26, 2023 · 0cc4aa9 · 0cc4aa9
1 parent 5ddfb8e
commit 0cc4aa9
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -43,9 +43,10 @@ The TokenE Webkit is a library that consists of many smaller NPM packages within
 
 Here are the packages in the namespace:
 
-| Package                                                                            | Description                                                            | Latest                                                                                                            |
-|------------------------------------------------------------------------------------|------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------|
-| [@tokene/toolkit](https://dl-tokene.github.io/webkit/modules/_tokene_toolkit.html) | A library for constructing JSON-API compliant requests and responses   | [![npm version](https://img.shields.io/npm/v/@tokene/toolkit.svg)](https://www.npmjs.com/package/@tokene/toolkit) |
+| Package                                                                                                | Description                                                                                                          | Latest                                                                                                                      |
+|--------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|
+| [@tokene/toolkit](https://dl-tokene.github.io/webkit/modules/_tokene_toolkit.html)                     | Collection of common utilities, functions, enums, errors and helpers                                                 | [![npm version](https://img.shields.io/npm/v/@tokene/toolkit.svg)](https://www.npmjs.com/package/@tokene/toolkit)           |
+| [@tokene/vue-web3-provider](https://dl-tokene.github.io/webkit/modules/_tokene_vue_web3_provider.html) | The Vue reactive wrapper of [@distributedlab/w3p](https://github.com/distributed-lab/web-kit/tree/main/packages/w3p) | [![npm version](https://img.shields.io/npm/v/@tokene/toolkit.svg)](https://www.npmjs.com/package/@tokene/vue-web3-provider) |
 
 ## Using in the projects made by create-react-app
 

diff --git a/packages/toolkit/README.md b/packages/toolkit/README.md
@@ -14,7 +14,7 @@ These packages aim to provide developers with a set of commonly used functions a
 yarn add @tokene/toolkit
 ```
 
-#### Work with big numbers
+#### Work with IPFS
 ```ts
 import { IpfsUtil } from '@tokene/toolkit'
 

diff --git a/packages/vue-web3-provider/README.md b/packages/vue-web3-provider/README.md
@@ -1,30 +1,36 @@
-# @tokene/toolkit
-These packages aim to provide developers with a set of commonly used functions and features for building TokenE web applications, such as handling big numbers, date manipulation, subscribing to and receiving notifications when certain events occur with EventEmitter, and more.
+# @tokene/vue-web3-provider
+The Vue reactive wrapper of [@distributedlab/w3p](https://github.com/distributed-lab/web-kit/tree/main/packages/w3p)
 
-![version (scoped package)](https://badgen.net/npm/v/@tokene/toolkit)
-![types](https://badgen.net/npm/types/@tokene/toolkit)
-![tree-shaking](https://badgen.net/bundlephobia/tree-shaking/@tokene/toolkit)
+![version (scoped package)](https://badgen.net/npm/v/@tokene/vue-web3-provider)
+![types](https://badgen.net/npm/types/@tokene/vue-web3-provider)
+![tree-shaking](https://badgen.net/bundlephobia/tree-shaking/@tokene/vue-web3-provider)
 ![checks](https://badgen.net/github/checks/dl-tokene/webkit/main)
 
 ## Getting Started
 
 ### Installing
 
 ```
-yarn add @tokene/toolkit
+yarn add @tokene/vue-web3-provider
 ```
 
-#### Work with big numbers
+#### Default example
 ```ts
-import { IpfsUtil } from '@tokene/toolkit'
+import { useProvider } from '@tokene/vue-web3-provider'
+import { ProviderDetector, MetamaskProvider } from '@distributedlab/w3p'
 
-const ipfsEntity = new IpfsUtil({
-  rawData: JSON.stringify({
-    someData: 'lorem ipsum dolor sit amet concestetur!',
-  }),
-})
+const providerDetector = new ProviderDetector()
+const provider = useProvider()
 
-await ipfsEntity.uploadSelf()
+const init = async () => {
+  await providerDetector.init()
+  await provider.init(MetamaskProvider, {
+    providerDetector: ProviderDetector,
+    listeners: {},
+  })
+}
+
+init()
 ```
 
 ## Running the tests
@@ -33,6 +39,10 @@ await ipfsEntity.uploadSelf()
 yarn test
 ```
 
+## More examples
+Check out more examples and use-cases:
+- [Multiple providers with the current selected one](https://github.com/distributed-lab/web-kit/blob/main/packages/w3p/examples/multiple-providers.ts)
+
 ## License
 
 This project is licensed under the MIT License - see the [LICENSE.md](../../LICENSE) file for details