diff --git a/README.md b/README.md index 7df87e0..bcbc81d 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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.