From d32f539791eb6887b69281ef0d531d59ca7c39f4 Mon Sep 17 00:00:00 2001 From: Arkadiy Kukarkin Date: Wed, 19 Sep 2018 15:29:23 -0400 Subject: [PATCH] Clarify preload behavior Preload is confusing because it happens on both add and get, and because it isn't documented anywhere in depth. This clarifies what happens a bit. We should also write out the behavior in more detail like with circuit relay above (possibly in the form of a tutorial for setting up your own preload node) see also https://github.com/ipfs/js-ipfs/issues/1459#issuecomment-422079307 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c5caed365f..397228563d 100644 --- a/README.md +++ b/README.md @@ -290,7 +290,7 @@ Configure circuit relay (see the [circuit relay tutorial](https://github.com/ipf |------|---------| | object | `{ enabled: true, addresses: [...] }` | -Configure external nodes that will preload content added to this node. +Configure remote preload nodes. The remote will preload content added on this node, and also attempt to preload objects requested by this node. - `enabled` (boolean): Enable content preloading (Default: `true`) - `addresses` (array): Multiaddr API addresses of nodes that should preload content. **NOTE:** nodes specified here should also be added to your node's bootstrap address list at [`config.Boostrap`](#optionsconfig).