Mirroristas/orbitdb
2
0
Fork 0
mirror of https://github.com/orbitdb/orbitdb.git synced 2025-06-05 21:56:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Exclude debug build from the npm package and add a note to README

Browse Source
This commit is contained in:
haad 2017-12-31 17:55:15 +02:00
parent 81be4fac15
commit f1b2f2252f
2 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.npmignore
View File

@ -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

2
README.md
View File

@ -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.