Skip to content

Commit

Permalink
Add TOC
Browse files Browse the repository at this point in the history
  • Loading branch information
clue committed Aug 11, 2015
1 parent fd4e211 commit 10b8f6a
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,21 @@ execute arbitrary commands within isolated containers, stop running containers a
* **Good test coverage** -
Comes with an automated tests suite and is regularly tested in the *real world*

> Note: This project is in beta stage! Feel free to report any issues you encounter.
**Table of contents**

* [Quickstart example](#quickstart-example)
* [Usage](#usage)
* [Factory](#factory)
* [createClient()](#createclient)
* [Client](#client)
* [Commands](#commands)
* [Promises](#promises)
* [Blocking](#blocking)
* [TAR streaming](#tar-streaming)
* [JSON streaming](#json-streaming)
* [JsonProgressException](#jsonprogressexception)
* [Install](#install)
* [License](#license)

## Quickstart example

Expand Down Expand Up @@ -53,6 +67,8 @@ $loop = React\EventLoop\Factory::create();
$factory = new Factory($loop);
```

#### createClient()

The `createClient($url = null)` method can be used to create a new `Client`.
It helps with constructing a `Browser` object for the given remote URL.

Expand Down

0 comments on commit 10b8f6a

Please sign in to comment.