Added updated library description and code examples for getCode/setCo…

…de and getStorage/setStorage to README

README.md

@@ -3,18 +3,23 @@
 [![NPM Package](https://img.shields.io/npm/v/ethereumjs-account.svg?style=flat-square)](https://www.npmjs.org/package/ethereumjs-account)
 [![Build Status](https://travis-ci.org/ethereumjs/ethereumjs-account.svg?branch=master)](https://travis-ci.org/ethereumjs/ethereumjs-account)
 [![Coverage Status](https://img.shields.io/coveralls/ethereumjs/ethereumjs-account.svg?style=flat-square)](https://coveralls.io/r/ethereumjs/ethereumjs-account)
-[![Gitter](https://img.shields.io/gitter/room/ethereum/ethereumjs-lib.svg?style=flat-square)](https://gitter.im/ethereum/ethereumjs-lib) or #ethereumjs on freenode
+[![Gitter](https://img.shields.io/gitter/room/ethereum/ethereumjs-lib.svg?style=flat-square)](https://gitter.im/ethereum/ethereumjs-lib)
+[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard)
 
- [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard)
+This library eases the handling of Ethereum accounts, where accounts can be either external accounts 
+or contracts (see 
+[Account Types](http://ethdocs.org/en/latest/contracts-and-transactions/account-types-gas-and-transactions.html) docs).
 
-Implements schema and functions relating to accounts stored ethereum's state Trie   
-NOTE: this is different from [ethereumjs-accounts](https://github.com/SilentCicero/ethereumjs-accounts) which should be used if you want to key management and web3 sugar.
+Note that the library is not meant to be used to handle your wallet accounts, use e.g. the
+[web3-eth-personal](http://web3js.readthedocs.io/en/1.0/web3-eth-personal.html) package from the 
+``web3.js`` library for that. This is just a semantic wrapper to ease the use of account data and
+provide functionality for reading and writing accounts from and to the Ethereum state trie.
 
 # INSTALL
 `npm install ethereumjs-account`
 
 # BROWSER
-This module work with `browserify`
+This module work with `browserify`.
 
 # API
  - [`new Account([data])`](#new-accountdata)
@@ -90,8 +95,61 @@ Stores the code in the trie.
 - `code` - A `Buffer`.
 - `cb` - The callback.
 
+Example for ``getCode`` and ``setCode``:
+```javascript
+// Requires manual merkle-patricia-tree install
+const SecureTrie = require('merkle-patricia-tree/secure')
+const Account = require('./index.js')
+
+let code = Buffer.from('73095e7baea6a6c7c4c2dfeb977efac326af552d873173095e7baea6a6c7c4c2dfeb977efac326af552d873157', 'hex')
+
+let raw = {
+  nonce: '',
+  balance: '0x03e7',
+  stateRoot: '0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421',
+  codeHash: '0xb30fb32201fe0486606ad451e1a61e2ae1748343cd3d411ed992ffcc0774edd4'
+}
+
+let account = new Account(raw)
+let trie = new SecureTrie()
+
+account.setCode(trie, code, function (err, codeHash) {
+  console.log(`Code with hash 0x${codeHash.toString('hex')} set to trie`)
+  account.getCode(trie, function (err, code) {
+    console.log(`Code ${code.toString('hex')} read from trie`)
+  })
+})
+```
+
 #### `account.getStorage(trie, key, cb)`
 Fetches `key` from the account's storage.
 
 #### `account.setStorage(trie, key, val, cb)`
 Stores a `val` at the `key` in the contract's storage.
+
+Example for ``getStorage`` and ``setStorage``:
+
+```javascript
+// Requires manual merkle-patricia-tree install
+const SecureTrie = require('merkle-patricia-tree/secure')
+const Account = require('./index.js')
+
+let raw = {
+  nonce: '',
+  balance: '0x03e7',
+  stateRoot: '0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421',
+  codeHash: '0xb30fb32201fe0486606ad451e1a61e2ae1748343cd3d411ed992ffcc0774edd4'
+}
+
+let account = new Account(raw)
+let trie = new SecureTrie()
+
+let key = Buffer.from('0000000000000000000000000000000000000000', 'hex')
+let value = Buffer.from('01', 'hex')
+
+account.setStorage(trie, key, value, function (err, value) {
+  account.getStorage(trie, key, function (err, value) {
+    console.log(`Value ${value.toString('hex')} set and retrieved from trie.`)
+  })
+})
+```