From 83de36474ec1057006438699a00ae86c7a05dad4 Mon Sep 17 00:00:00 2001
From: Patrick <blockchainbuddha@gmail.com>
Date: Wed, 17 Feb 2021 21:57:06 -0500
Subject: [PATCH] cleanup docs

---
 README.md | 28 +++++++++++++---------------
 1 file changed, 13 insertions(+), 15 deletions(-)

diff --git a/README.md b/README.md
index 268a255..234bfc6 100644
--- a/README.md
+++ b/README.md
@@ -29,9 +29,6 @@ const { logIn, logOut, getCurrentUser, client } = useAuth();
 
 // 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)
@@ -231,25 +228,25 @@ const LoginPage = () => {
 export default LoginPage;
 ```
 
-## Wallet Connect support
+## Wallet Connect
 
 You must pass an optional `rpc` or `infuraId` to use Wallet Connect.
 
-```
+```js
 ethereum = new EthereumAuthClient({
   makeRequest,
   // Note: you must set NODE_ENV manually when using Netlify
-  debug: process.NODE_ENV !== 'development',
-  infuraId: process.env.INFURA_ID,
-})
+  debug: process.NODE_ENV !== "development",
+  infuraId: process.env.INFURA_ID
+  // For rpc see https://docs.walletconnect.org/quick-start/dapps/web3-provider#provider-options
+});
 ```
 
-Read more about using the [rpc provider](https://docs.walletconnect.org/quick-start/dapps/web3-provider#provider-options).
-
-Then when you call `unlock()` pass the type "walletConnect".
+Then pass the type "walletConnect" when you unlock
 
 ```js
 const { logIn, logOut, getCurrentUser } = useAuth()
+
 const onClickWalletConnect = async () => {
   await logIn("walletConnect")
 ```
@@ -283,11 +280,12 @@ yarn build:watch
 yarn rwt copy:watch ../redwood
 ```
 
-## Planned features
+## TODO
 
-- Change default method to use `walletconnect`
-- Export typescript types here for the user object, instead of declaring them inside `@redwoodjs/auth`
-- Add support for `walletlink`
+- [x] Add support for `walletconnect`
+- [ ] Allow direct access to the ethers `provider` on the client.
+- [ ] Export typescript types here for the user object, instead of declaring them inside `@redwoodjs/auth`
+- [ ] Add support for `walletlink`
 
 ## Publishing