A few doc updates

Author: yondonfu

.soliumrc.json

@@ -17,6 +17,11 @@
     "indentation": true,
     "whitespace": true,
     "deprecated-suicide": true,
-    "pragma-on-top": true
+    "pragma-on-top": true,
+    "overflow-indentation": false,
+    "semicolon-whitespace": true,
+    "conditionals-whitespace": true,
+    "function-whitespace": false,
+    "comma-whitespace": true
   }
 }

CONTRIBUTING.md

@@ -2,6 +2,7 @@
 
 ## Style Guidelines
 
+We use [Solium](https://github.com/duaraghav8/Solium) to enforce Solidity coding conventions and [ESLint](https://eslint.org/) to enforce Javascript coding conventions.
 Below are a few style guidelines to be used when contributing to the Livepeer Protocol.
 
 #### Solidity

README.md

@@ -17,26 +17,23 @@ This is a work in progress LivepeerProtocol implementation. See the [Dev Roadmap
 To build and test the Livepeer Protocol locally:
 
 ```
-# Install and Launch TestRPC
-npm install -g ethereumjs-testrpc
-
 # Clone the repo and install dependencies
 git clone https://github.com/livepeer/protocol.git
 cd protocol
 npm install
 
 # Start testrpc
-testrpc
+npm run testrpc
 
 # Run the tests in another console window
-truffle test
+npm run test
 ```
 
 Tests involving verification via Oraclize require [ethereum-bridge](https://github.com/oraclize/ethereum-bridge)
 
 ```
 # Start testrpc
-testrpc
+npm run test
 
 # Start ethereum-bridge in another console window
 git clone https://github.com/oraclize/ethereum-bridge.git

package.json

@@ -8,7 +8,7 @@
   },
   "scripts": {
     "lint": "npm run eslint; npm run solium",
-    "eslint": "./node_modules/eslint/bin/eslint.js util/** test/**",
+    "eslint": "./node_modules/eslint/bin/eslint.js util/** scripts/** test/**",
     "solium": "./node_modules/solium/bin/solium.js --dir ./contracts",
     "test": "npm run lint; truffle test",
     "testrpc": "testrpc"

parseArtifacts.js renamed to scripts/parseArtifacts.js

@@ -1,53 +1,53 @@
-const fs = require("fs");
-const path = require("path");
-const mkdirp = require("mkdirp");
+const fs = require("fs")
+const path = require("path")
+const mkdirp = require("mkdirp")
 
 const parseArtifact = (inFile, outDir, outFile, type = "abi") => {
     fs.readFile(inFile, (err, data) => {
         if (err) {
-            console.error("Failed to read " + inFile + ": " + err);
+            console.error("Failed to read " + inFile + ": " + err)
         } else {
-            const json = JSON.parse(data);
+            const json = JSON.parse(data)
 
-            let jsonData;
+            let jsonData
 
             if (type == "bin") {
-                jsonData = json.unlinked_binary;
+                jsonData = json.unlinked_binary
             } else {
-                jsonData = JSON.stringify(json.abi);
+                jsonData = JSON.stringify(json.abi)
             }
 
 
             mkdirp(outDir, err => {
                 if (err) {
-                    console.error("Failed to ensure directory " + outDir + ": " + err);
+                    console.error("Failed to ensure directory " + outDir + ": " + err)
                 }
 
                 fs.writeFile(outFile, jsonData, err => {
                     if (err) {
-                        console.error("Failed to write " + outFile + ": " + err);
+                        console.error("Failed to write " + outFile + ": " + err)
                     }
-                });
-            });
+                })
+            })
         }
-    });
-};
+    })
+}
 
-const ARTIFACT_DIR = path.resolve(__dirname, "build/contracts");
-const ABI_DIR = path.resolve(__dirname, "abi");
-const BIN_DIR = path.resolve(__dirname, "bin");
+const ARTIFACT_DIR = path.resolve(__dirname, "../build/contracts")
+const ABI_DIR = path.resolve(__dirname, "../abi")
+const BIN_DIR = path.resolve(__dirname, "../bin")
 
 fs.readdir(ARTIFACT_DIR, (err, files) => {
     if (err) {
-        console.error("Failed to read " + ARTIFACT_DIR + ": " + err);
+        console.error("Failed to read " + ARTIFACT_DIR + ": " + err)
     } else {
         files.forEach(filename => {
-            const artifactFile = path.join(ARTIFACT_DIR, filename);
-            const abiFile = path.join(ABI_DIR, path.basename(filename, ".json") + ".abi");
-            const binFile = path.join(BIN_DIR, path.basename(filename, ".json") + ".bin");
+            const artifactFile = path.join(ARTIFACT_DIR, filename)
+            const abiFile = path.join(ABI_DIR, path.basename(filename, ".json") + ".abi")
+            const binFile = path.join(BIN_DIR, path.basename(filename, ".json") + ".bin")
 
-            parseArtifact(artifactFile, ABI_DIR, abiFile, "abi");
-            parseArtifact(artifactFile, BIN_DIR, binFile, "bin");
-        });
+            parseArtifact(artifactFile, ABI_DIR, abiFile, "abi")
+            parseArtifact(artifactFile, BIN_DIR, binFile, "bin")
+        })
     }
-});
+})