From 59d9931c7cb0db4dc7eff78874194ed5ca7d985f Mon Sep 17 00:00:00 2001
From: Iuri Matias <iuri.matias@gmail.com>
Date: Tue, 21 Aug 2018 13:31:14 -0400
Subject: [PATCH] update readme

---
 README.md | 106 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 105 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 36bb5d4901..25e83a72b0 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,107 @@
 [![Build Status](https://travis-ci.org/ethereum/remix-tests.svg?branch=master)](https://travis-ci.org/ethereum/remix-tests)
 
-# remix-tests
+Remix-Tests
+---
+
+### Installation
+
+`npm -g install remix-tests`
+
+### Test structure
+
+Example test file:
+```Javascript
+pragma solidity ^0.4.7;
+import "remix_tests.sol"; // injected by remix-tests
+import "./simple_storage.sol";
+
+contract MyTest {
+  SimpleStorage foo;
+  uint i = 0;
+
+  function beforeAll() {
+    foo = new SimpleStorage();
+  }
+
+  function beforeEach() {
+    if (i == 1) {
+      foo.set(200);
+    }
+    i += 1;
+  }
+
+  function initialValueShouldBe100() public {
+    Assert.equal(foo.get(), 100, "initial value is not correct");
+  }
+
+  function initialValueShouldBe200() public constant returns {
+    return Assert.equal(foo.get(), 200, "initial value is not correct");
+  }
+
+}
+```
+
+Available special functions:
+* `beforeEach` - runs before each test
+* `beforeAll` - runs before all tests
+
+#### Assert library
+
+Available functions:
+`Assert.ok(value, message)`
+`Assert.equal(value1, value2, message)`
+`Assert.notEqual(value1, value2, message)`
+
+supported values currently are: `bool` `uint` `int` `address` `bytes32`
+
+### Command Line
+
+Usage:
+
+* A directory with tests files `remix-tests examples/`
+* A test file `remix-tests examples/simple_storage_test.sol`
+
+### Library
+
+Importing the library:
+```Javascript
+const RemixTests = require('remix-tests');
+```
+
+Running a single test object:
+```Javascript
+remixTests.runTest(contractName, contractObj, testCallback, resultsCallback)
+```
+params:
+`testName` - `string` name of the test
+`testObj` -  web3.js 1.0 contract instance of the test
+`testCallback(object)` -  called each time there is a test event. 3 possible type of objects:
+* `{ type: 'contract', value: '<TestName>', filename: '<test_filename.sol>' }`
+* `{ type: 'testPass', value: '<name of testing function>', time: <time taken>, context: '<TestName>'}`
+* `{ type: 'testFailure', value: '<name of testing function>', time: <time taken>, context: '<TestName>', errMsg: '<message in the Assert>' }`
+
+`resultsCallback(object)`
+* `passingNum` - number of passing tests
+* `failureNum` - number of failing tests
+* `timePassed` - time it took for all the tests to run (in seconds)
+
+
+Running a set of tests given the sourcecode:
+```Javascript
+remixTests.runTestSources(contractSources, testCallback, resultCallback, finalCallback, importFileCb);
+```
+params:
+`contractSources` - `object` -> `filename => { content: source }`
+`testCallback(object)` - called each time there is a test event. 3 possible type of objects:
+* `{ type: 'contract', value: '<TestName>', filename: '<test_filename.sol>' }`
+* `{ type: 'testPass', value: '<name of testing function>', time: <time taken>, context: '<TestName>'}`
+* `{ type: 'testFailure', value: '<name of testing function>', time: <time taken>, context: '<TestName>', errMsg: '<message in the Assert>' }`
+
+`resultCallback(object)`
+* `passingNum` - number of passing tests
+* `failureNum` - number of failing tests
+* `timePassed` - time it took for all the tests to run (in seconds)
+
+`finalCallback(err)` - called when all tests finish running.
+`importCb(url, cb)`
+