From 74bee956e7ce8b24b3df91ea760db57d98590c58 Mon Sep 17 00:00:00 2001
From: Georges KABBOUCHI <georges.kabbouchi@gmail.com>
Date: Sat, 28 Aug 2021 21:25:21 +0300
Subject: [PATCH] Update README.md

---
 README.md | 58 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 57 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 932a216..28e7629 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,57 @@
-# @kabbouchi/vue-web3
\ No newline at end of file
+# @kabbouchi/vue-web3 - experimental
+
+Vue 2/3 wrapper for web3 built on top of [react-web3](https://github.com/NoahZinsmeister/web3-react).
+
+## 🚀 Quick Start
+
+Install:
+
+```bash
+# npm
+npm i @kabbouchi/vue-web3
+
+# yarn
+yarn add @kabbouchi/vue-web3
+```
+
+Usage:
+
+```js
+import { useWeb3, setWeb3LibraryCallback } from '@kabbouchi/vue-web3'
+import { InjectedConnector } from '@web3-react/injected-connector'
+import { WalletConnectConnector } from '@web3-react/walletconnect-connector'
+
+import Web3 from 'web3'
+
+const injected = new InjectedConnector({
+  supportedChainIds: [1, 137],
+})
+
+const walletconnect = new WalletConnectConnector({
+  rpc: { 1: 'https://mainnet.infura.io/v3/YOUR_API_KEY' },
+  qrcode: true,
+})
+
+setWeb3LibraryCallback((provider) => new Web3(provider))
+
+defineComponent({
+  setup() {
+    const { active, activate, account, library } = useWeb3()
+
+    const connectUsingMetamask = async () => {
+      await activate(injected)
+    }
+
+    const connectUsingWalletConnect = async () => {
+      await activate(walletconnect)
+    }
+
+    return {
+      active,
+      connect,
+      connectUsingMetamask,
+      connectUsingWalletConnect,
+    }
+  },
+})
+```