initial take at readme update

CONTRIBUTING.md

@@ -1,14 +1,18 @@
 ### Contributing Guide 
 
+## Warnig
+
 We are currently in the process of ironing out the legal stuff regarding doing our very first (strategic) open source project.
 
 In particular we are still missing a contributor license agreement and automatic tooling to make sure PRs sign it.
 
 If you would like to contribute in the meantime please contact us ([email protected] / [email protected]) directly.
 
+
+
 ## Technical Know-How
 
-The project is a yarn workspace in order to build it:
+This monorepo is managed with yarn workspaces in order to build it:
 
 ```shell
 # install dependencies
@@ -20,4 +24,20 @@ yarn test
 
 Because the project is still pretty early if you want to contribute  but unsure how please contact us.
 
-Pleae note our code of conduct. We take it seriously and we value diverse contributions and have a zero tolerance policy towards discrimination of any kind.
+Pleae note our code of conduct. We take it seriously and we value diverse contributions and have a zero tolerance policy towards discrimination of any kind.
+
+
+## Publish workflow
+
+We use lerna for publishing.
+
+We use [lerna canary publish](https://github.com/lerna/lerna/tree/master/commands/publish#--canary) for PRs.  
+
+To release prod packages, we use [lerna from-git workflow](https://github.com/lerna/lerna/tree/master/commands/publish#bump-from-git).  
+You need to run `lerna version` locally on master branch. it will create version commit, tags and push it to the git remote
+
+Our versioning strategy is `dependent` and not `independent`. means all of the released packages will have the same version.
+
+### We are not semver compatible yet! keep version number below 1.0
+
+For all the other details, look at [.circleci/config.yml](.circleci/config.yml)

README.md

@@ -1,18 +1,21 @@
 # Testim Root Cause
 
-This is the Testim Root Cause monorepo.
+This is the [Testim Root Cause](https://www.testim.io/root-cause/) monorepo. Please check out [the documentation](https://help.testim.io/docs/root-cause).
 
-This monorepo is managed by yarn with workspaces.  
-We also use lerna for publishing.
 
-## Publish workflow
-We have [lerna canary publish](https://github.com/lerna/lerna/tree/master/commands/publish#--canary) for PR's.  
+![Root Cause](https://user-images.githubusercontent.com/1315533/91361835-d129a480-e801-11ea-96c7-a22b8ee98046.gif)
 
-To release prod packages, we use [lerna from-git workflow](https://github.com/lerna/lerna/tree/master/commands/publish#bump-from-git).  
-You need to run `lerna version` locally on master branch. it will create version commit, tags and push it to the git remote
+Please see the [contributing guide](CONTRIBUTING.md) and note this project has a [Code Of Conduct](CODE_OF_CONDUCT.md)
+
+## Testim Root Cause
+
+Root Cause is a tool for troubleshooting Puppeteer and Playwright tests.
+
+We believe modern automation frameworks like Puppeteer, Playwright and Selenium are pretty fast and useful but maintaining and debugging tests is hard.
+
+Root Cause adds features to simplify root cause analysis of Puppeteer and Playwright test runs. Root Cause captures screenshots, network HAR files, and console logs from each test run and saves them to a local drive. The screenshots highlight the action taken at each step and are easily viewed in succession through an intuitive UI to demonstrate the test flow or to identify where a test failed. Additionally, the console logs are parsed to each test step and network HAR is available to deep-dive into failed steps.
+
+Note that this project is a yarn workspace and packages inside have specific READMEs.
 
-Our versioning strategy is `dependent` and not `independent`. means all of the released packages will have the same version.
 
-## We are not semver compatible yet! keep version number below 1.0
 
-For all the other details, look at [.circleci/config.yml](.circleci/config.yml)