Improve the implementation of the truebit package for publication

truebit-implementation/node_modules/eth-contract-class/.editorconfig → truebit-implementation/.editorconfig

@@ -1,13 +1,14 @@
-# http://editorconfig.org
+# Editor configuration, see http://editorconfig.org
 root = true
 
 [*]
+charset = utf-8
 indent_style = space
 indent_size = 2
 end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
 insert_final_newline = true
+trim_trailing_whitespace = true
 
 [*.md]
+max_line_length = off
 trim_trailing_whitespace = false

truebit-implementation/.env

@@ -0,0 +1,2 @@
+MNENOMIC=
+INFURA_API_KEY=

truebit-implementation/.gitignore

@@ -0,0 +1,4 @@
+/node_modules
+/build
+package-lock.json
+.env

truebit-implementation/.npmignore

@@ -0,0 +1,6 @@
+/node_modules
+package-lock.json
+.editorconfig
+.env
+/screenshots
+/test

truebit-implementation/README.md

@@ -0,0 +1,30 @@
+# truebit-iico-beta-dev
+
+## How to deploy the contract into the infura-rinkeby network
+
+- Clone this repository
+- Open the `truebit-implementation` folder
+- Install the dependencies using `npm install`
+- Add the required variables to to the `.env` file:
+
+**MNEMONIC** is the mnemonic of your wallet, if you are using metamask you can get this under **Setting > Reveal Seed Words**
+
+**INFURA_API_KEY** is the API KEY provided by infura
+
+- Deploy the contract using `npm run deploy-contract-infura`
+- You will see the deployed contact address on the console
+![contract_address](./screenshots/deploying_contract.PNG "contract_address")
+
+**Notes:** 
+- Rember to whitelist the contract address in the infura dashboard in order to use it
+- Please do not commit/push changes in the `.env` file to this repository
+
+### Changelog
+
+- **Breaking Changes:** starting in version `1.0.0` you should import the `IICO` and `IICOABI` like:
+
+```js
+import { IICO, IICOABI } from 'truebit-iico-beta-dev';
+```
+
+- **Breaking Changes:** starting in version `2.0.0` you can only import the `IICOABI`