Do a pass on readme and docs.

CONTRIBUTING.md

@@ -11,20 +11,20 @@ You can report issues [here](https://github.com/vast-community-hub/sunit-extensi
 - This project is MIT licensed, so any code contribution MUST be under the same license.
 - This project uses [Semantic Versioning](http://semver.org/), so keep it in mind when you make backwards-incompatible changes. If some backwards incompatible change is made the major version MUST be increased.
 - The source code is hosted in this repository using the Tonel format in the `source` folder.
-- The `release-candidate` branch contains the latest changes and should always be in a releasable state.
+- The `master` branch contains the latest changes and should always be in a releasable state.
 - Feel free to send pull requests or fork the project.
 - Code contributions without test cases have a lower probability of being merged into the main branch.
 
 
 ### Using Tonel
-1. Download a [VASmalltalk](https://www.instantiations.com/products/vasmalltalk/download.html)
-2. Clone the project or your fork using Git
-3. Using Tonel, load all the Configuration Maps.
-6. Create a new branch to host your code changes
-7. Do the changes
-8. Run the test cases
-9. Commit and push your changes to the branch using Git
-10. Create a Pull Request against the `release-candidate` branch
+1. Install [VA Smalltalk 9.2.1 or newer](https://www.instantiations.com/products/vasmalltalk/download.html).
+2. Clone this project or your fork using Git.
+6. Create a new branch to host your code changes.
+3. Using Tonel, load all the desired Configuration Maps or Applications.
+7. Do the changes.
+8. Run the test cases.
+9. Commit and push your changes to the created branch using Git.
+10. Create a Pull Request against the `master` branch.
 
 
 ## Contributing documentation

README.md

@@ -16,16 +16,36 @@
 </p>
 
 
- UI Eventing Framework to use for SUnit Testing
+ UI Eventing Framework to use for SUnit Testing. This allows users to also write SUnit Test for GUI components. 
 
 ## License
 - The code is licensed under [MIT](LICENSE).
 - The documentation is licensed under [CC BY-SA 4.0](http://creativecommons.org/licenses/by-sa/4.0/).
 
 
+## Installation
+
+1. Install [VA Smalltalk 9.2.1 or newer](https://www.instantiations.com/products/vasmalltalk/download.html).
+2. Install Tonel support in your development image following [this guide](https://github.com/vasmalltalk/tonel-vast#installation).
+3. Clone this repository.
+4. Load the Configuration Map `VastSUnitExtensions` either from the context menu of the Configuration Maps Browser ("*Import*" -> "*Load Configuration Maps from Tonel repository...*" -> select path to root `sunit-extensions-vast` local repo) or via a script:
+
+```smalltalk
+| loader path |
+path := (CfsPath named: '<insert path to root sunit-extensions-vast local repo here>').
+loader := TonelLoader readFromPath: path.
+loader
+	beUnattended.
+	useGitVersion.
+loader loadAllMapsWithRequiredMaps.
+```
+
+
 ## Quick Start
 
-## Installation
+This repository includes tests which also work as examples for users to get started. Check the application `VastSUnitExtensionsExamplesApp` and you will find examples such as `TestEtDictionaryInspector`, `TestEtTextComparisonBrowser`, `TestEtWorkspace`, etc.
+
+Ultimately, all you need to do is to subclass `EtWindowsTestCase` or `UITestCase` and call their API from within your tests.
 
 ## Contributing
 

scripts/tonel-export.st

@@ -1,5 +1,5 @@
 | writer path |
-path := ((CfsPath named: CfsDirectoryDescriptor getcwd) append: '..\tonel-repos\sunit-extensions-vast').
+path := (CfsPath named: '<insert path to root sunit-extensions-vast local repo here>').
 writer := TonelWriter new.
 writer
 	addLatestConfigurationMapNamed: 'VastSUnitExtensions';

scripts/tonel-import.st

@@ -1,5 +1,5 @@
 | loader path |
-path := ((CfsPath named: CfsDirectoryDescriptor getcwd) append: '..\tonel-repos\sunit-extensions-vast').
+path := (CfsPath named: '<insert path to root sunit-extensions-vast local repo here>').
 loader := TonelLoader readFromPath: path.
 loader
 	beUnattended;