Merge 39fa304 into 124b7c0

web3 · Dec 7, 2020 · 80930c5 · 80930c5
2 parents 124b7c0 + 39fa304
commit 80930c5
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/packages/web3-providers-ipc/README.md b/packages/web3-providers-ipc/README.md
@@ -15,14 +15,16 @@ npm install web3-providers-ipc
 ```
 
 ## Usage
-
 ```js
 const Web3IpcProvider = require('web3-providers-ipc');
 const net = require(net);
 
+// connect to your local ipc
 const ipc = new Web3IpcProvider('/Users/me/Library/Ethereum/geth.ipc', net);
 ```
 
+Note: make sure to run [geth](https://geth.ethereum.org/).
+
 ## Types
 
 All the TypeScript typings are placed in the `types` folder.