doc updates

testingisdocumenting · May 4, 2018 · c1d0924 · c1d0924
1 parent 2c790bc
commit c1d0924
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 4 deletions.
diff --git a/webtau-docs/webtau/REST/getting-started.md b/webtau-docs/webtau/REST/getting-started.md
@@ -1,3 +1,7 @@
+# Installation
+
+Download and unzip [webtau](https://github.com/twosigma/webtau/releases/). Add it to your `PATH`.
+
 # Bare Minimum
 
 :include-file: examples/rest/restGet.groovy {title: "examples/rest/restGet.groovy"}
@@ -6,6 +10,9 @@ To run test, navigate to `examples` dir and
 
 :include-cli-command: webtau rest/restGet.groovy --url=https://my-server {paramsToHighlight: "url"}
 
+Note: using `package` and `import` is optional and is mainly for IDE auto completion. Imports will be added implicitly
+during command line run.  
+
 # Config File
 
 Url parameter can be moved to a `test.cfg` file.

diff --git a/webtau-docs/webtau/index.md b/webtau-docs/webtau/index.md
@@ -1,7 +1,15 @@
 # WebTau 
 
-Java API and Groovy Framework to test:
-* Web UI
+WebTau (**Web** **T**est **au**tomation) - Java API and Groovy Framework to test:
 * Web REST
+* Web UI
+
+```columns
+left:
+:include-file: examples/simpleRest.groovy
+
+right:
+:include-file: examples/Search.groovy
+```
+
 
-:include-file: examples/Search.groovy
diff --git a/webtau-docs/webtau/meta.json b/webtau-docs/webtau/meta.json
@@ -1,4 +1,8 @@
 {
   "title": "WebTau",
-  "type": "Guide"
+  "type": "Guide",
+  "viewOn": {
+    "link": "https://github.com/twosigma/webtau/tree/master/webtau-docs/webtau",
+    "title": "View On GitHub"
+  }
 }
diff --git a/webtau-groovy/examples/simpleRest.groovy b/webtau-groovy/examples/simpleRest.groovy
@@ -0,0 +1,7 @@
+import static com.twosigma.webtau.WebTauGroovyDsl.*
+
+scenario("simple get") {
+    http.get("/weather") {
+        temperature.should == 88
+    }
+}