docs: improve api documentation

clebert · Apr 3, 2017 · 4560cac · 4560cac
1 parent e912a07
commit 4560cac
Showing 1 changed file with 8 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -893,12 +893,18 @@ Type definition:
 
 - **`sendKeys(...keys: string[]): Action`**
 
-Example [TAP][28] output: `TODO`
+Example [TAP][28] output: `ok 1 - send keys [ 'f', 'o', 'o' ] to element '#bar' (attempt 1 of 5)`
 
 Example usage:
 
 ```ts
-TODO
+const {defineElement, test} = require('cybernaut');
+
+test('foo', async t => {
+  const bar = defineElement('#bar');
+
+  await t.perform(bar.sendKeys('f', 'o', 'o'));
+});
 ```
 
 #### [`submitForm`](#api)