ethereum-address - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

@@ -5,3 +5,3 @@ {
   "description": "Ethereum address validation",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "engineStrict": true,
@@ -8,0 +8,0 @@ "engines": {

README.md

 # ethereum-address
+
 Ethereum address validation
 
 This is a clone of the [web3.js](https://github.com/ethereum/web3.js)
-`isAddress` utility method, but without the rest of web3.js.
+[`isAddress`](https://github.com/ethereum/web3.js/blob/master/lib/utils/utils.js)
+utility method, but without the rest of web3.js.
 
+## Install
+
 ```
-https://github.com/ethereum/web3.js/blob/master/lib/utils/utils.js
+npm install ethereum-address
 ```
+
+## Usage
+
+```
+var ethereum_address = require('ethereum-address');
+
+if (ethereum_address.isAddress(value)) {
+  console.log('Valid ethereum address.');
+}
+else {
+  console.log('Invalid Ethereum address.');
+}
+```
+
+## API
+
+### isAddress (address)
+
+Returns true if the address (string) is an Ethereum address
+
+### isChecksumAddress (address)
+
+Returns true if the address (string) is an Ethereum checksum address

No alert changes

Improved metrics

Total package byte prevSize

4277

increased by11.82%

Number of lines in readme file

37

increased by270%

No dependency changes