From 8f7ca415061b1ab46452e5c40fa6f34572389920 Mon Sep 17 00:00:00 2001 From: Paul Frazee Date: Wed, 10 Jul 2019 14:31:37 -0500 Subject: [PATCH] Document client.ready() --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index a4d1da8..89e5ba9 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,9 @@ Check out the [daemon tests](https://github.com/andrewosh/hyperdrive-daemon/blob ### Hyperdrive The client's Hyperdrive API is designed to mirror the methods in Hyperdrive as closely as possible. +##### `await client.ready([cb])` +Returns a promise which resolves when the client is ready to use. Can accept a callback to use instead of the returned promise. + #### Session Operations ##### `const { info, id } = await client.drive.get(opts)`