From 2504cbeb2608557199e0d08e8ba9e115464a434a Mon Sep 17 00:00:00 2001 From: David Dias Date: Sun, 22 Oct 2017 10:27:36 +0100 Subject: [PATCH] docs: add missing sections to the README (#128) --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/README.md b/README.md index fc1d7026..d6c05ed5 100644 --- a/README.md +++ b/README.md @@ -263,6 +263,42 @@ class Node extends libp2p { [multiaddr]: https://github.com/multiformats/js-multiaddr [Connection]: https://github.com/libp2p/interface-connection +## Development + +**Clone and install dependencies:** + +```sh +> git clone https://github.com/ipfs/js-ipfs.git +> cd js-ipfs +> npm install +``` + +### Tests + +#### Run unit tests + +```sh +# run all the unit tsts +> npm test + +# run just Node.js tests +> npm run test:node + +# run just Browser tests (Chrome) +> npm run test:browser +``` + +#### Run interop tests + +```sh +N/A +``` + +#### Run benchmark tests + +```sh +N/A +``` ### Packages