Merge pull request #123 from ethereum/cleanup-readme

Cleanup code style in readme

Author: axic

README.md

@@ -34,13 +34,14 @@ used in combination with an Ethereum client via the `eth.compile.solidity()` RPC
 It can also be included and used in other projects:
 
 ```javascript
-var solc = require('solc');
-var input = 'contract x { function g() {} }';
-var output = solc.compile(input, 1); // 1 activates the optimiser
+var solc = require('solc')
+var input = 'contract x { function g() {} }'
+// Setting 1 as second paramateractivates the optimiser
+var output = solc.compile(input, 1)
 for (var contractName in output.contracts) {
 	// code and ABI that are needed by web3
-	console.log(contractName + ': ' + output.contracts[contractName].bytecode);
-	console.log(contractName + '; ' + JSON.parse(output.contracts[contractName].interface));
+	console.log(contractName + ': ' + output.contracts[contractName].bytecode)
+	console.log(contractName + '; ' + JSON.parse(output.contracts[contractName].interface))
 }
 ```
 
@@ -49,14 +50,14 @@ for (var contractName in output.contracts) {
 Starting from version 0.1.6, multiple files are supported with automatic import resolution by the compiler as follows:
 
 ```javascript
-var solc = require('solc');
+var solc = require('solc')
 var input = {
 	'lib.sol': 'library L { function f() returns (uint) { return 7; } }',
 	'cont.sol': 'import "lib.sol"; contract x { function g() { L.f(); } }'
-};
-var output = solc.compile({sources: input}, 1);
+}
+var output = solc.compile({ sources: input }, 1)
 for (var contractName in output.contracts)
-	console.log(contractName + ': ' + output.contracts[contractName].bytecode);
+	console.log(contractName + ': ' + output.contracts[contractName].bytecode)
 ```
 
 Note that all input files that are imported have to be supplied, the compiler will not load any additional files on its own.
@@ -66,19 +67,19 @@ Note that all input files that are imported have to be supplied, the compiler wi
 Starting from version 0.2.1, a callback is supported to resolve missing imports as follows:
 
 ```javascript
-var solc = require('solc');
+var solc = require('solc')
 var input = {
 	'cont.sol': 'import "lib.sol"; contract x { function g() { L.f(); } }'
-};
-function findImports(path) {
+}
+function findImports (path) {
 	if (path === 'lib.sol')
 		return { contents: 'library L { function f() returns (uint) { return 7; } }' }
 	else
 		return { error: 'File not found' }
 }
-var output = solc.compile({sources: input}, 1, findImports);
+var output = solc.compile({ sources: input }, 1, findImports)
 for (var contractName in output.contracts)
-	console.log(contractName + ': ' + output.contracts[contractName].bytecode);
+	console.log(contractName + ': ' + output.contracts[contractName].bytecode)
 ```
 
 The `compile()` method always returns an object, which can contain `errors`, `sources` and `contracts` fields. `errors` is a list of error mesages.
@@ -87,6 +88,8 @@ The `compile()` method always returns an object, which can contain `errors`, `so
 
 Starting from version 0.4.11 there is a new entry point named `compileStandardWrapper()` which supports Solidity's [standard JSON input and output](https://solidity.readthedocs.io/en/develop/using-the-compiler.html#compiler-input-and-output-json-description). It also maps old compiler output to it.
 
+### Using with Electron
+
 **Note:**
 If you are using Electron, `nodeIntegration` is on for `BrowserWindow` by default. If it is on, Electron will provide a `require` method which will not behave as expected and this may cause calls, such as `require('solc')`, to fail.
 
@@ -97,21 +100,21 @@ new BrowserWindow({
 	webPreferences: {
 		nodeIntegration: false
 	}
-});
+})
 ```
 
 ### Using a Legacy Version
 
 In order to compile contracts using a specific version of Solidity, the `solc.useVersion` method is available. This returns a new `solc` object that uses a version of the compiler specified. **Note**: version strings must match the version substring of the files available in `/bin/soljson-*.js`. See below for an example.
 
 ```javascript
-var solc = require('solc');
+var solc = require('solc')
 // by default the latest version is used
 // ie: solc.useVersion('latest')
 
 // getting a legacy version
-var solcV011 = solc.useVersion('v0.1.1-2015-08-04-6ff4cd6');
-var output = solcV011.compile('contract t { function g() {} }', 1);
+var solcV011 = solc.useVersion('v0.1.1-2015-08-04-6ff4cd6')
+var output = solcV011.compile('contract t { function g() {} }', 1)
 ```
 
 If the version is not available locally, you can use `solc.loadRemoteVersion(version, callback)` to load it directly from GitHub.
@@ -124,15 +127,15 @@ You can also load the "binary" manually and use `setupMethods` to create the fam
 By default, the npm version is only created for releases. This prevents people from deploying contracts with non-release versions because they are less stable and harder to verify. If you would like to use the latest development snapshot (at your own risk!), you may use the following example code.
 
 ```javascript
-var solc = require('solc');
+var solc = require('solc')
 
 // getting the development snapshot
-solc.loadRemoteVersion('latest', function(err, solcSnapshot) {
+solc.loadRemoteVersion('latest', function (err, solcSnapshot) {
 	if (err) {
 		// An error was encountered, display and quit
 	}
-	var output = solcSnapshot.compile("contract t { function g() {} }", 1);
-});
+	var output = solcSnapshot.compile("contract t { function g() {} }", 1)
+})
 ```
 
 ### Linking Bytecode
@@ -142,7 +145,7 @@ When using libraries, the resulting bytecode will contain placeholders for the r
 The `linkBytecode` method provides a simple helper for linking:
 
 ```javascript
-bytecode = solc.linkBytecode(bytecode, { 'MyLibrary': '0x123456...' });
+bytecode = solc.linkBytecode(bytecode, { 'MyLibrary': '0x123456...' })
 ```
 
 Note: in future versions of Solidity a more sophisticated linker architecture will be introduced.  Once that changes, this method will still be usable for output created by old versions of Solidity.
@@ -153,9 +156,9 @@ The ABI generated by Solidity versions can differ slightly, due to new features
 
 It can be used as:
 ```javascript
-var abi = require('solc/abi');
+var abi = require('solc/abi')
 
-var inputABI = [{"constant":false,"inputs":[],"name":"hello","outputs":[{"name":"","type":"string"}],"payable":false,"type":"function"}];
+var inputABI = [{"constant":false,"inputs":[],"name":"hello","outputs":[{"name":"","type":"string"}],"payable":false,"type":"function"}]
 var outputABI = abi.update('0.3.6', inputABI)
 // Output contains: [{"constant":false,"inputs":[],"name":"hello","outputs":[{"name":"","type":"string"}],"payable":true,"type":"function"},{"type":"fallback","payable":true}]