update docs

README.md

@@ -4,30 +4,38 @@
   </a>
 </p>
 
-> Auth provider for RedwoodJS using Ethererum.
+> Ethereum auth provider for RedwoodJS
 
-This package was inspired from a [lengthy tutorial](https://patrickgallagher.dev/blog/2020/12/27/tutorial-redwood-web3-login/tutorial-add-web3-login-to-redwoodjs) I wrote on adding Ethereum auth to Redwood. If you're planning to implement your own custom auth to RedwoodJS (aside from Ethereum), you may find that tutorial useful.
+Looking to implement your own custom Redwood Auth? You may this [tutorial](https://patrickgallagher.dev/blog/2020/12/27/tutorial-redwood-web3-login/tutorial-add-web3-login-to-redwoodjs) helpful.
 
 ### ✨ [Demo](https://redwood-ethereum-login-demo.vercel.app/)
 
 Demo [source code](https://github.com/oneclickdapp/redwood-ethereum-login-demo)
 
-## Overview
+<div align="center" >
+ <img margin="0 0 10px" width="500" src="./ocd-ethereum-auth.gif"/>
+</div>
 
-This package enables the full suite of tooling that `@redwoodjs/auth` provides. Read more about auth in the official RedwoodJS docs https://redwoodjs.com/docs/authentication
+## Quick Start
 
 ```js
-import { useAuth } from "@redwoodjs/auth";
+const ethereum = new EthereumAuthClient({
+  makeRequest,
+  debug: process.NODE_ENV !== "development",
+  infuraId: process.env.INFURA_ID
+});
 
-const LoginPage = () => {
-  const { logIn } = useAuth();
+const { logIn, logOut, getCurrentUser, client } = useAuth();
 
-  const onClick = async () => {
-    // Trigger wallet unlock & message signature
-    await logIn();
-  };
+// Trigger authentication
+await logIn("walletConnect");
+
+// Access the ethers provider directly
+await client.provider.getSigner();
 ```
 
+If this is your first time using Redwood Auth, you should check out the official Redwood [auth docs](https://redwoodjs.com/docs/authentication)
+
 ## Setup
 
 If you haven't created a redwood app yet, you can do so now. See my [introductory blog post](https://patrickgallagher.dev/blog/2020/11/18/web3-redwood-intro/using-redwoodjs-to-create-an-ethereum-app) for more help getting started.

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oneclickdapp/ethereum-auth",
-  "version": "0.2.0",
-  "description": "Auth provider for RedwoodJS using Ethererum",
+  "version": "0.2.1",
+  "description": "Ethereum auth provider for RedwoodJS",
   "author": "Patrick Gallagher <[email protected]>",
   "main": "dist/index.js",
   "module": "src/index.js",

src/client.js

@@ -47,7 +47,7 @@ class EthereumAuthClient {
 
   async login(type = WALLET_TYPES.browser) {
     try {
-      const isWalletConnect = WALLET_TYPES.walletConnect;
+      const isWalletConnect = type === WALLET_TYPES.walletConnect;
       let unlock = unlockBrowser;
       if (isWalletConnect) {
         if (!this.rpc && !this.infuraId)