diff --git a/packages/xen-api/README.md b/packages/xen-api/README.md index b5fef027f..dcfb33882 100644 --- a/packages/xen-api/README.md +++ b/packages/xen-api/README.md @@ -28,9 +28,18 @@ var xapi = createClient({ auth: { user: 'root', password: 'important secret password' - } + }, + readOnly: false }) +``` +Options: + +- `url`: address of a host in the pool we are trying to connect to +- `auth`: credentials used to sign in +- `readOnly = false`: if true, no methods with side-effects can be called + +```js // Force connection. xapi.connect().catch(error => { console.error(error)