Merge pull request #26 from ethereum-alarm-clock/prettier

ran code through prettier bumped version

.prettierrc.yml

@@ -0,0 +1,4 @@
+useTabs: true
+tabWidth: 4
+semi: false
+trailingComma: all

README.md

@@ -4,10 +4,10 @@ _Note: `eac.js` is operational but still considered alpha software, released to
 
 # eac.js
 
-A tool to interact with the [Ethereum Alarm Clock](https://github.com/ethereum-alarm-clock/ethereum-alarm-clock) protocol.
-It is both a commandline tool for running an execution client or scheduling a transaction as well
-as a Javascript library and an extension on the standard web3.js library facilitating an open API
-for interacting with the Ethereum Alarm Clock contracts from Javascript.
+A tool and library to interact with the [Ethereum Alarm Clock](https://github.com/ethereum-alarm-clock/ethereum-alarm-clock) protocol.
+You can use the commandline tool for running an execution client or scheduling a transaction.
+The library is available to make it easy for developers to get started using the contracts
+from their web3 javascript code.
 
 ## Documentation
 

docs/API/constants.md

@@ -4,13 +4,17 @@
 console.log(eac.Constants)
 
 {
-    GT_HEX: '0x3e',
-    LT_HEX: '0x3c',
-    GTE_HEX: '0x3e3d',
-    LTE_HEX: '0x3c3d',
-    EQ_HEX: '0x3d3d',
-    NULL_ADDRESS: '0x0000000000000000000000000000000000000000',
-    EXECUTEDLOG: '0x3e504bb8b225ad41f613b0c3c4205cdd752d1615b4d77cd1773417282fcfb5d9',
-    ABORTEDLOG: '0xc008bc849b42227c61d5063a1313ce509a6e99211bfd59e827e417be6c65c81b'
+	GT_HEX: "0x3e",
+	LT_HEX: "0x3c",
+	GTE_HEX: "0x3e3d",
+	LTE_HEX: "0x3c3d",
+	EQ_HEX: "0x3d3d",
+	NULL_ADDRESS: "0x0000000000000000000000000000000000000000",
+	EXECUTEDLOG:
+		"0x3e504bb8b225ad41f613b0c3c4205cdd752d1615b4d77cd1773417282fcfb5d9",
+	ABORTEDLOG:
+		"0xc008bc849b42227c61d5063a1313ce509a6e99211bfd59e827e417be6c65c81b",
+	NEWREQUESTLOG:
+		"0x2749295aa7ffdbd4d16719dc03d592cd081eebd9bb790ceedce201a40675fc03",
 }
 ```

docs/Executing_Tut.md

@@ -7,13 +7,14 @@ execute them. If the client successfully executes a transaction, it will
 be rewarded with the `payment` that was set by the scheduler as well
 as reimbursed for all the gas costs. 
 
-_Note: Currenlty eac.js is only available for the Ropsten testnet and only
-works on a parity local node._
+_Note: Currenlty eac.js is only available for the Ropsten or Kovan testnet and only
+works on a parity local node. Geth support is not available on the stable branch
+and is not recommended at this time._
 
 ## Setting up a Parity local node
 
-To run the execution client while it is in beta requires the set up of a 
-Parity local node on the Ropsten test network. This requirement is due to 
+To run the execution client on the commandline requires the set up of a 
+Parity local node on the Ropsten or Kovan test networks. This requirement is due to 
 the fact that the client relies on a Parity-specific API for checking
 the transaction pool for existing calls to contracts. Without this 
 RPC call, the client will try to send transactions on top of other clients
@@ -22,7 +23,7 @@ losing the client some gas fees. You can download Parity by following the
 instructions on their [github](https://github.com/paritytech/parity).
 
 For the sake of this tutorial, we will be using the Ropsten network, but all
-the commands should work by specifying the Kovan network just as well.
+the commands should work by specifying the Kovan network instead.
 
 We begin by creating a new account.
 
@@ -44,9 +45,8 @@ $ parity --geth --chain ropsten --unlock <YOUR ACCOUNT> --password <PASSWORD FIL
 ```
 
 Parity should continue syncing with your account unlocked. Your next
-steps should be finding a source for some Kovan Ether, we recommend asking
-on the Kovan Faucet Gitter chat, they're usually responsive! If that doesn't work 
-trying pinging @lsaether on Gitter or asking in the Ethereum Alarm Clock room.
+steps should be finding a source for some Ropsten Ether, try the [Metamask
+faucet](faucet.metamask.io) or ask in the Ethereum Alarm Clock Gitter room.
 
 ## Running the client
 
@@ -101,5 +101,10 @@ populate a test transaction by using the command `.testTx`. Note! This will use
 your default unlocked account to send a transaction to the network so make sure
 you have enough testnet ether in your account to do this.
 
+One last note! The logs will be output to ~/.eac.log. You can follow the output
+by opening a new terminal screen and running `tail -f ~/.eac.log`. Remember that
+you can change the logging output inside the REPL using the `.logLevel <num>`
+command.
+
 And that's all there is to it. If you have any questions please join us on Gitter,
 or raise an issue on Github. Thanks for using the tool! 🙂

package.json

@@ -1,6 +1,6 @@
 {
   "name": "eac.js",
-  "version": "0.9.8",
+  "version": "1.0.0-rc",
   "description": "Commnandline tool to interact with the Ethereum Alarm Clock contracts.",
   "main": "./src/index.js",
   "scripts": {
@@ -50,6 +50,7 @@
   "devDependencies": {
     "@digix/tempo": "^0.2.0",
     "babel-cli": "^6.26.0",
-    "babel-preset-env": "^1.6.1"
+    "babel-preset-env": "^1.6.1",
+    "prettier": "1.10.2"
   }
 }