docs: browser agent

gemini-testing · Jun 6, 2017 · 765bd63 · 765bd63
1 parent 7d18e50
commit 765bd63
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -13,6 +13,7 @@ Utility which contains common modules for [gemini](https://github.com/gemini-tes
 - [Options](#options)
   - [Sets](#sets)
 - [BrowserPool](#browserpool)
+- [BrowserAgent](#browseragent)
 - [Errors](#errors)
   - [CancelledError](#cancellederror)
 
@@ -134,6 +135,22 @@ return pool.getBrowser('bro')
 
 ```
 
+### BrowserAgent
+
+Example:
+```js
+const BrowserAgent = require('gemini-core').BrowserAgent;
+const BrowserPool = require('gemini-core').BrowserPool;
+const pool = BrowserPool.create(/*BrowserManager, config*/);
+const browserAgent = BrowserAgent.create('bro-id', pool);
+
+return browserAgent.getBrowser()
+    .then((bro) => {
+        ...
+        return browserAgent.freeBrowser(bro/*, {force: true}*/);
+    });
+```
+
 ### Errors
 
 #### CancelledError