From f1b2f2252fa028a7da64e5713210fb2f8e2062d1 Mon Sep 17 00:00:00 2001 From: haad Date: Sun, 31 Dec 2017 17:55:15 +0200 Subject: [PATCH] Exclude debug build from the npm package and add a note to README --- .npmignore | 2 +- README.md | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/.npmignore b/.npmignore index 8b71956..1cb7b36 100644 --- a/.npmignore +++ b/.npmignore @@ -12,7 +12,7 @@ examples/ dist/*.map # Don't distribute the debug build -dist/orbitdb.debug.js +dist/orbitdb.js # Don't distribute screenshot # See examples at https://github.com/orbitdb/orbit-db diff --git a/README.md b/README.md index 6ec623f..c413fda 100644 --- a/README.md +++ b/README.md @@ -93,6 +93,8 @@ ipfs.on('ready', async () => { *For more details, see examples for [kvstore](https://github.com/orbitdb/orbit-db-kvstore#usage), [eventlog](https://github.com/haadcode/orbit-db-eventstore#usage), [feed](https://github.com/haadcode/orbit-db-feedstore#usage), [docstore](https://github.com/shamb0t/orbit-db-docstore#usage) and [counter](https://github.com/haadcode/orbit-db-counterstore#usage).* +*The minimum required version of Node.js is now 8.0.0. To use with older versions of Node.js, we provide an ES5-compatible build through the npm package, located in `dist/es5/` when installed through npm.* + ## API See [API documentation](https://github.com/orbitdb/orbit-db/blob/master/API.md#orbit-db-api-documentation) for the full documentation.