@@ -81,7 +81,7 @@ You can check the development status at the [Waffle Board](https://waffle.io/ipf
81
81
- [ Packages] ( #packages )
82
82
- [ Development] ( #development )
83
83
- [ Clone and install dependencies] ( #clone-and-install-dependencies )
84
- - [ Run Tests] ( #run-unit- tests )
84
+ - [ Run Tests] ( #run-tests )
85
85
- [ Lint] ( #lint )
86
86
- [ Build a dist version] ( #build-a-dist-version )
87
87
- [ Contribute] ( #contribute )
@@ -521,109 +521,112 @@ The core API is grouped into several areas:
521
521
- [` ipfs.files.write(path, content, [options], [callback])` ](https: // github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#fileswrite)
522
522
523
523
- [block](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/BLOCK.md)
524
- - [` ipfs.block.get(cid, [options, callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/BLOCK.md#get )
525
- - [` ipfs.block.put(block, cid, [callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/BLOCK.md#put )
526
- - [` ipfs.block.stat(cid, [callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/BLOCK.md#stat )
524
+ - [` ipfs.block.get(cid, [options], [ callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/BLOCK.md#blockget )
525
+ - [` ipfs.block.put(block, cid, [callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/BLOCK.md#blockput )
526
+ - [` ipfs.block.stat(cid, [callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/BLOCK.md#blockstat )
527
527
528
528
#### Graph
529
529
530
530
- [dag](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/DAG.md)
531
- - [` ipfs.dag.put(dagNode, options, callback)` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/DAG.md#dagput)
532
- - [` ipfs.dag.get(cid [, path, options], callback)` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/DAG.md#dagget)
533
- - [` ipfs.dag.tree(cid [, path, options], callback)` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/DAG.md#dagtree)
534
-
535
- - [object](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/OBJECT.md).
536
- - [` ipfs.object.new([template][, callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/OBJECT.md#objectnew)
537
- - [` ipfs.object.put(obj, [options, callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/OBJECT.md#objectput)
538
- - [` ipfs.object.get(multihash, [options, callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/OBJECT.md#objectget)
539
- - [` ipfs.object.data(multihash, [options, callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/OBJECT.md#objectdata)
540
- - [` ipfs.object.links(multihash, [options, callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/OBJECT.md#objectlinks)
541
- - [` ipfs.object.stat(multihash, [options, callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/OBJECT.md#objectstat)
542
- - [` ipfs.object.patch.addLink(multihash, DAGLink, [options, callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/OBJECT.md#objectpatchaddlink)
543
- - [` ipfs.object.patch.rmLink(multihash, DAGLink, [options, callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/OBJECT.md#objectpatchrmlink)
544
- - [` ipfs.object.patch.appendData(multihash, data, [options, callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/OBJECT.md#objectpatchappenddata)
545
- - [` ipfs.object.patch.setData(multihash, data, [options, callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/OBJECT.md#objectpatchsetdata)
531
+ - [` ipfs.dag.put(dagNode, [ options], [ callback] )` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/DAG.md#dagput)
532
+ - [` ipfs.dag.get(cid, [ path], [ options], [ callback] )` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/DAG.md#dagget)
533
+ - [` ipfs.dag.tree(cid, [ path], [ options], [ callback] )` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/DAG.md#dagtree)
534
+
535
+ - [object](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/OBJECT.md)
536
+ - [` ipfs.object.new([template], [ callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/OBJECT.md#objectnew)
537
+ - [` ipfs.object.put(obj, [options], [ callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/OBJECT.md#objectput)
538
+ - [` ipfs.object.get(multihash, [options], [ callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/OBJECT.md#objectget)
539
+ - [` ipfs.object.data(multihash, [options], [ callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/OBJECT.md#objectdata)
540
+ - [` ipfs.object.links(multihash, [options], [ callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/OBJECT.md#objectlinks)
541
+ - [` ipfs.object.stat(multihash, [options], [ callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/OBJECT.md#objectstat)
542
+ - [` ipfs.object.patch.addLink(multihash, DAGLink, [options], [ callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/OBJECT.md#objectpatchaddlink)
543
+ - [` ipfs.object.patch.rmLink(multihash, DAGLink, [options], [ callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/OBJECT.md#objectpatchrmlink)
544
+ - [` ipfs.object.patch.appendData(multihash, data, [options], [ callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/OBJECT.md#objectpatchappenddata)
545
+ - [` ipfs.object.patch.setData(multihash, data, [options], [ callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/OBJECT.md#objectpatchsetdata)
546
546
547
547
- [pin](https: // github.com/ipfs/interface-ipfs-core/blob/master/SPEC/PIN.md)
548
548
- [` ipfs.pin.add(hash, [options], [callback])` ](https: // github.com/ipfs/interface-ipfs-core/blob/master/SPEC/PIN.md#pinadd)
549
549
- [` ipfs.pin.ls([hash], [options], [callback])` ](https: // github.com/ipfs/interface-ipfs-core/blob/master/SPEC/PIN.md#pinls)
550
550
- [` ipfs.pin.rm(hash, [options], [callback])` ](https: // github.com/ipfs/interface-ipfs-core/blob/master/SPEC/PIN.md#pinrm)
551
551
552
- ### Name
552
+ #### Name
553
553
554
554
- [name](https: // github.com/ipfs/interface-ipfs-core/blob/master/SPEC/NAME.md)
555
- - [` ipfs.name.publish(value, [options, callback])` ](https: // github.com/ipfs/interface-ipfs-core/blob/master/SPEC/NAME.md#namepublish)
556
- - [` ipfs.name.resolve(value, [options, callback])` ](https: // github.com/ipfs/interface-ipfs-core/blob/master/SPEC/NAME.md#nameresolve)
555
+ - [` ipfs.name.publish(value, [options], [ callback])` ](https: // github.com/ipfs/interface-ipfs-core/blob/master/SPEC/NAME.md#namepublish)
556
+ - [` ipfs.name.resolve(value, [options], [ callback])` ](https: // github.com/ipfs/interface-ipfs-core/blob/master/SPEC/NAME.md#nameresolve)
557
557
558
558
#### Crypto and Key Management
559
559
560
560
- [key](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/KEY.md)
561
- - ` ipfs.key.export(name, password, [callback])`
562
- - ` ipfs.key.gen(name, options, [callback])`
563
- - ` ipfs.key.import(name, pem, password, [callback])`
564
- - ` ipfs.key.list([callback])`
565
- - ` ipfs.key.rename(oldName, newName, [callback])`
566
- - ` ipfs.key.rm(name, [callback])`
567
- - [crypto (not yet implemented)](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC)
561
+ - [` ipfs.key.export(name, password, [callback])` ](https: // github.com/ipfs/interface-ipfs-core/blob/master/SPEC/KEY.md#keyexport)
562
+ - [` ipfs.key.gen(name, options, [callback])` ](https: // github.com/ipfs/interface-ipfs-core/blob/master/SPEC/KEY.md#keygen)
563
+ - [` ipfs.key.import(name, pem, password, [callback])` ](https: // github.com/ipfs/interface-ipfs-core/blob/master/SPEC/KEY.md#keyimport)
564
+ - [` ipfs.key.list([callback])` ](https: // github.com/ipfs/interface-ipfs-core/blob/master/SPEC/KEY.md#keylist)
565
+ - [` ipfs.key.rename(oldName, newName, [callback])` ](https: // github.com/ipfs/interface-ipfs-core/blob/master/SPEC/KEY.md#keyrename)
566
+ - [` ipfs.key.rm(name, [callback])` ](https: // github.com/ipfs/interface-ipfs-core/blob/master/SPEC/KEY.md#keyrm)
567
+
568
+ - crypto (not implemented yet)
568
569
569
570
#### Network
570
571
571
- - [bootstrap](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/)
572
- - ` ipfs.bootstrap.list`
573
- - ` ipfs.bootstrap.add`
574
- - ` ipfs.bootstrap.rm`
572
+ - [bootstrap](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/BOOTSTRAP.md )
573
+ - [ ` ipfs.bootstrap.list([callback]) ` ](https : // github.com/ipfs/interface-ipfs-core/blob/master/SPEC/BOOTSTRAP.md#bootstraplist)
574
+ - [ ` ipfs.bootstrap.add(addr, [options], [callback]) ` ](https : // github.com/ipfs/interface-ipfs-core/blob/master/SPEC/BOOTSTRAP.md#bootstrapadd)
575
+ - [ ` ipfs.bootstrap.rm(peer, [options], [callback]) ` ](https : // github.com/ipfs/interface-ipfs-core/blob/master/SPEC/BOOTSTRAP.md#bootstraprm)
575
576
576
- - [bitswap](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/)
577
- - ` ipfs.bitswap.wantlist()`
578
- - ` ipfs.bitswap.stat()`
579
- - ` ipfs.bitswap.unwant()`
577
+ - [bitswap](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/BITSWAP.md)
578
+ - [` ipfs.bitswap.wantlist([peerId], [callback])` ](https: // github.com/ipfs/interface-ipfs-core/blob/master/SPEC/BITSWAP.md#bitswapwantlist)
579
+ - [` ipfs.bitswap.stat([callback])` ](https: // github.com/ipfs/interface-ipfs-core/blob/master/SPEC/BITSWAP.md#bitswapstat)
580
580
581
- - [ dht (not implemented, yet! )](https : // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/ )
581
+ - dht (not implemented yet)
582
582
583
583
- [pubsub](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/PUBSUB.md)
584
- - [` ipfs.pubsub.subscribe(topic, handler, options, callback)` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/PUBSUB.md#pubsubsubscribe)
585
- - [` ipfs.pubsub.unsubscribe(topic, handler, callback)` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/PUBSUB.md#pubsubunsubscribe)
586
- - [` ipfs.pubsub.publish(topic, data, callback)` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/PUBSUB.md#pubsubpublish)
587
- - [` ipfs.pubsub.ls(topic, callback)` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/PUBSUB.md#pubsubls)
588
- - [` ipfs.pubsub.peers(topic, callback)` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/PUBSUB.md#pubsubpeers)
584
+ - [` ipfs.pubsub.subscribe(topic, handler, [ options], [ callback] )` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/PUBSUB.md#pubsubsubscribe)
585
+ - [` ipfs.pubsub.unsubscribe(topic, handler, [ callback] )` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/PUBSUB.md#pubsubunsubscribe)
586
+ - [` ipfs.pubsub.publish(topic, data, [ callback] )` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/PUBSUB.md#pubsubpublish)
587
+ - [` ipfs.pubsub.ls(topic, [ callback] )` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/PUBSUB.md#pubsubls)
588
+ - [` ipfs.pubsub.peers(topic, [ callback] )` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/PUBSUB.md#pubsubpeers)
589
589
590
- - [libp2p](https: // github.com/libp2p/interface-libp2p). Every IPFS instance also exposes the libp2p SPEC at `ipfs.libp2p`. The formal interface for this SPEC hasn't been defined by you can find documentation at its implementations:
590
+ - [libp2p](https: // github.com/libp2p/interface-libp2p). Every IPFS instance also exposes the libp2p SPEC at `ipfs.libp2p`. The formal interface for this SPEC hasn't been defined but you can find documentation at its implementations:
591
591
- [Node .js bundle](./ src/ core/ runtime/ libp2p- nodejs .js )
592
592
- [Browser Bundle](./ src/ core/ runtime/ libp2p- browser .js )
593
593
- [libp2p baseclass](https: // github.com/libp2p/js-libp2p)
594
594
595
595
- [swarm](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/SWARM.md)
596
- - [` ipfs.swarm.addrs([callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/SWARM.md#addrs )
597
- - [` ipfs.swarm.connect(addr, [callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/SWARM.md#connect )
598
- - [` ipfs.swarm.disconnect(addr, [callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/SWARM.md#disconnect )
599
- - [` ipfs.swarm.peers([opts] [, callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/SWARM.md#peers )
596
+ - [` ipfs.swarm.addrs([callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/SWARM.md#swarmaddrs )
597
+ - [` ipfs.swarm.connect(addr, [callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/SWARM.md#swarmconnect )
598
+ - [` ipfs.swarm.disconnect(addr, [callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/SWARM.md#swarmdisconnect )
599
+ - [` ipfs.swarm.peers([options], [ callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/SWARM.md#swarmpeers )
600
600
601
601
#### Node Management
602
602
603
603
- [miscellaneous operations](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/MISCELLANEOUS.md)
604
604
- [` ipfs.id([callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/MISCELLANEOUS.md#id)
605
605
- [` ipfs.version([callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/MISCELLANEOUS.md#version)
606
- - ` ipfs.ping()`
607
- - ` ipfs.init([options], callback)`
606
+ - [` ipfs.ping(peerId, [options], [callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/MISCELLANEOUS.md#ping)
607
+ - [` ipfs.pingReadableStream(peerId, [options])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/MISCELLANEOUS.md#pingreadablestream)
608
+ - [` ipfs.pingPullStream(peerId, [options])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/MISCELLANEOUS.md#pingpullstream)
609
+ - ` ipfs.init([options], [callback])`
608
610
- ` ipfs.start([callback])`
609
611
- [` ipfs.stop([callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/MISCELLANEOUS.md#stop)
610
612
- ` ipfs.isOnline()`
613
+ - [` ipfs.resolve(name, [options], [callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/MISCELLANEOUS.md#resolve)
611
614
612
615
- [repo](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/REPO.md)
613
616
- ` ipfs.repo.init`
614
- - [` ipfs.repo.stat([options, callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/REPO.md#stat )
615
- - [` ipfs.repo.version([callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/REPO.md#version )
616
- - ` ipfs.repo.gc([options, callback])` (not implemented, yet! )
617
+ - [` ipfs.repo.stat([options], [ callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/REPO.md#repostat )
618
+ - [` ipfs.repo.version([callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/REPO.md#repoversion )
619
+ - ` ipfs.repo.gc([options], [ callback])` (not implemented yet)
617
620
618
621
- [stats](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/STATS.md)
619
- - [` ipfs.stats.bitswap([callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/STATS.md#bitswap )
620
- - [` ipfs.stats.bw([options, callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/STATS.md#bw )
621
- - [` ipfs.stats.bwPullStream([options]) -> Pull Stream` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/STATS.md#bwpullstream )
622
- - [` ipfs.stats.bwReadableStream([options]) -> Readable Stream` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/STATS.md#bwreadablestream )
623
- - [` ipfs.stats.repo([options, callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/STATS.md#repo )
622
+ - [` ipfs.stats.bitswap([callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/STATS.md#statsbitswap )
623
+ - [` ipfs.stats.bw([options], [ callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/STATS.md#statsbw )
624
+ - [` ipfs.stats.bwPullStream([options]) -> Pull Stream` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/STATS.md#statsbwpullstream )
625
+ - [` ipfs.stats.bwReadableStream([options]) -> Readable Stream` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/STATS.md#statsbwreadablestream )
626
+ - [` ipfs.stats.repo([options], [ callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/STATS.md#statsrepo )
624
627
625
628
- [config](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/CONFIG.md)
626
- - [` ipfs.config.get([key, callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/CONFIG.md#configget)
629
+ - [` ipfs.config.get([key], [ callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/CONFIG.md#configget)
627
630
- [` ipfs.config.set(key, value, [callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/CONFIG.md#configset)
628
631
- [` ipfs.config.replace(config, [callback])` ](https: // github.com/ipfs/interface-ipfs-core/tree/master/SPEC/CONFIG.md#configreplace)
629
632
@@ -635,7 +638,7 @@ A set of data types are exposed directly from the IPFS instance under `ipfs.type
635
638
- [`ipfs.types.PeerId`](https://github.com/libp2p/js-peer-id)
636
639
- [`ipfs.types.PeerInfo`](https://github.com/libp2p/js-peer-info)
637
640
- [`ipfs.types.multiaddr`](https://github.com/multiformats/js-multiaddr)
638
- - [`ipfs.types.multibase`](https://github.com/multiformats/multibase)
641
+ - [`ipfs.types.multibase`](https://github.com/multiformats/js- multibase)
639
642
- [`ipfs.types.multihash`](https://github.com/multiformats/js-multihash)
640
643
- [`ipfs.types.CID`](https://github.com/ipld/js-cid)
641
644
- [`ipfs.types.dagPB`](https://github.com/ipld/js-ipld-dag-pb)
@@ -684,7 +687,7 @@ To add WebRTC support in a IPFS node instance, do:
684
687
```JavaScript
685
688
const wrtc = require(' wrtc' ) // or require(' electron- webrtc' )()
686
689
const WStar = require(' libp2p- webrtc- star' )
687
- const wstar = new WStar({ wrtc: wrtc })
690
+ const wstar = new WStar({ wrtc })
688
691
689
692
const node = new IPFS({
690
693
repo: ' your- repo- path' ,
@@ -894,7 +897,7 @@ Listing of the main packages used in the IPFS ecosystem. There are also three sp
894
897
> npm install
895
898
` ` `
896
899
897
- ### Run unit tests
900
+ ### Run tests
898
901
899
902
` ` ` sh
900
903
# run all the unit tsts
@@ -949,7 +952,7 @@ Run the interop tests with https://github.com/ipfs/interop
949
952
950
953
### Build a dist version
951
954
952
- ` ` `
955
+ ` ` ` sh
953
956
> npm run build
954
957
` ` `
955
958
@@ -966,7 +969,7 @@ Run the interop tests with https://github.com/ipfs/interop
966
969
src # Main source code folder
967
970
├── cli # Implementation of the IPFS CLI
968
971
│ └── ...
969
- ├── http-api # The HTTP-API implementation of IPFS as defined by http-api-spec
972
+ ├── http # The HTTP-API implementation of IPFS as defined by http-api-spec
970
973
├── core # IPFS implementation, the core (what gets loaded in browser)
971
974
│ ├── components # Each of IPFS subcomponent
972
975
│ └── ...
0 commit comments