This repository has been archived by the owner on Feb 12, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Merged
update README #33
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,17 @@ | ||
node-ipfs | ||
js-ipfs | ||
========= | ||
|
||
> IPFS Node.js entry point and implementation roadmap | ||
> IPFS JavaScript implementation entry point and roadmap | ||
|
||
# Description | ||
|
||
This repo will contain the entry point for the Node.js implementation of IPFS spec, similar to [go-ipfs](https://github.com/ipfs/go-ipfs). Right now, it holds the roadmap for the development of modules for node-ipfs, as well as their current state. | ||
This repo will contain the entry point for the JavaScript implementation of IPFS spec, similar to [go-ipfs](https://github.com/ipfs/go-ipfs). Right now, it holds the roadmap for the development of modules for js-ipfs, as well as their current state. | ||
|
||
We are building node-ipfs because it will inform how go-ipfs works, separate concerns, and allow a complete in-browser-tab implementation with no install friction. Most of the work for IPFS does happen elsewhere, but this is an equally important part of our roadmap to lead to a permanent, IPFSed web. | ||
We are building js-ipfs because it will inform how go-ipfs works, separate concerns, and allow a complete in-browser-tab implementation with no install friction. Most of the work for IPFS does happen elsewhere, but this is an equally important part of our roadmap to lead to a permanent, IPFSed web. | ||
|
||
# Contribute | ||
|
||
IPFS in Node is a work in progress. As such, there's a few things you can do right now to help out: | ||
IPFS implementation in JavaScript is a work in progress. As such, there's a few things you can do right now to help out: | ||
|
||
* Go through the modules below and **check out existing issues**. This would be especially useful for modules in active development. Some knowledge of IPFS may be required, as well as the infrasture behind it - for instance, you may need to read up on p2p and more complex operations like muxing to be able to help technically. | ||
* **Perform code reviews**. Most of this has been developed by @diasdavid, which means that more eyes will help a) speed the project along b) ensure quality and c) reduce possible future bugs. | ||
|
@@ -27,54 +27,54 @@ IPFS in Node is a work in progress. As such, there's a few things you can do rig | |
|
||
- Network | ||
- [ ] [libp2p-website](https://github.com/diasdavid/libp2p-website). | ||
- [ ] [node-libp2p](https://github.com/diasdavid/node-libp2p) _(the entry point)_. | ||
- [x] [PeerInfo](https://github.com/diasdavid/node-peer-info) | ||
- [x] [PeerId](https://github.com/diasdavid/node-peer-id) | ||
- [ ] [js-libp2p](https://github.com/diasdavid/js-libp2p) _(the entry point)_. | ||
- [x] [PeerInfo](https://github.com/diasdavid/js-peer-info) | ||
- [x] [PeerId](https://github.com/diasdavid/js-peer-id) | ||
- Peer Routing | ||
- [x] [node-ipfs-kad-router](https://github.com/diasdavid/node-ipfs-kad-router). [Discussion issue](https://github.com/ipfs/node-ipfs/issues/18). | ||
- [x] [js-ipfs-kad-router](https://github.com/diasdavid/js-ipfs-kad-router). [Discussion issue](https://github.com/ipfs/js-ipfs/issues/18). | ||
- discovery mechanisms | ||
- [x] [node-ipfs-mdns](https://github.com/diasdavid/node-ipfs-mdns) _mDNS-discovery_. [Discussion issue](https://github.com/ipfs/node-ipfs/issues/19). | ||
- [ ] [node-ipfs-random-walk](https://github.com/diasdavid/node-ipfs-random-walk). [Discussion issue](https://github.com/ipfs/node-ipfs/issues/20). | ||
- [x] [node-ipfs-railing](https://github.com/diasdavid/node-ipfs-railing) _Bootstrap-list_. [Discussion issue](https://github.com/ipfs/node-ipfs/issues/21). | ||
- [x] [js-ipfs-mdns](https://github.com/diasdavid/js-ipfs-mdns) _mDNS-discovery_. [Discussion issue](https://github.com/ipfs/js-ipfs/issues/19). | ||
- [ ] [js-ipfs-random-walk](https://github.com/diasdavid/js-ipfs-random-walk). [Discussion issue](https://github.com/ipfs/js-ipfs/issues/20). | ||
- [x] [js-ipfs-railing](https://github.com/diasdavid/js-ipfs-railing) _Bootstrap-list_. [Discussion issue](https://github.com/ipfs/js-ipfs/issues/21). | ||
- [ ] mDNS-routing | ||
- [x] Swarm. | ||
- Main repo [node-libp2p-swarm](https://github.com/diasdavid/node-libp2p-swarm). [Discussion issue](https://github.com/ipfs/node-ipfs/issues/22). | ||
- [x] Identify Protocol [identify](https://github.com/diasdavid/node-libp2p-swarm/tree/master/src/identify). | ||
- [x] [node-ipfs-ping](https://github.com/diasdavid/node-ipfs-ping). | ||
- Main repo [js-libp2p-swarm](https://github.com/diasdavid/js-libp2p-swarm). [Discussion issue](https://github.com/ipfs/js-ipfs/issues/22). | ||
- [x] Identify Protocol [identify](https://github.com/diasdavid/js-libp2p-swarm/tree/master/src/identify). | ||
- [x] [js-ipfs-ping](https://github.com/diasdavid/js-ipfs-ping). | ||
- [x] Connection Interface [abstract-connection](https://github.com/diasdavid/abstract-connection) | ||
- Transports | ||
- [x] Transport Interface [abstract-transport](https://github.com/diasdavid/abstract-transport) | ||
- [x] [libp2p-tcp](https://github.com/diasdavid/node-libp2p-tcp) | ||
- [ ] [libp2p-udp](https://github.com/diasdavid/node-libp2p-udp) | ||
- [ ] [libp2p-udt](https://github.com/diasdavid/node-libp2p-udt) | ||
- [ ] [libp2p-utp](https://github.com/diasdavid/node-libp2p-utp) | ||
- [x] [libp2p-tcp](https://github.com/diasdavid/js-libp2p-tcp) | ||
- [ ] [libp2p-udp](https://github.com/diasdavid/js-libp2p-udp) | ||
- [ ] [libp2p-udt](https://github.com/diasdavid/js-libp2p-udt) | ||
- [ ] [libp2p-utp](https://github.com/diasdavid/js-libp2p-utp) | ||
- [ ] libp2p-webrtc | ||
- [ ] libp2p-cjdns | ||
- Upgrades | ||
- [ ] libp2p-tls | ||
- Stream Muxing | ||
- [x] [abstract-stream-muxer](https://github.com/diasdavid/abstract-stream-muxer). | ||
- [x] [node-spdy-stream-muxer](https://github.com/diasdavid/node-spdy-stream-muxer) _stream muxer_. [Discussion issue](https://github.com/ipfs/node-ipfs/issues/23). | ||
- [x] [libp2p-spdy](https://github.com/diasdavid/node-libp2p-spdy/blob/master/src/index.js) _stream muxer upgrade_ | ||
- [x] [js-spdy-stream-muxer](https://github.com/diasdavid/js-spdy-stream-muxer) _stream muxer_. [Discussion issue](https://github.com/ipfs/js-ipfs/issues/23). | ||
- [x] [libp2p-spdy](https://github.com/diasdavid/js-libp2p-spdy/blob/master/src/index.js) _stream muxer upgrade_ | ||
- Protocol Muxing | ||
- [x] [node-multistream](https://github.com/diasdavid/node-multistream) _protocol muxer_. [Discussion issue](https://github.com/ipfs/node-ipfs/issues/24). | ||
- [x] [node-multistream](https://github.com/diasdavid/node-multistream). | ||
- [ ] Distributed Record Store. [Discussion issue](https://github.com/ipfs/node-ipfs/issues/25). | ||
- [x] [node-ipfs-record](https://github.com/diasdavid/node-ipfs-record) _record (needs MerkleDAG node)_. | ||
- [x] [node-ipfs-distributed-record-store](https://github.com/diasdavid/node-ipfs-distributed-record-store). | ||
- [x] [node-ipfs-kad-record-store](https://github.com/diasdavid/node-ipfs-kad-record-store) _implements abstract record store_. | ||
- [x] [js-multistream](https://github.com/diasdavid/js-multistream) _protocol muxer_. [Discussion issue](https://github.com/ipfs/js-ipfs/issues/24). | ||
- [x] [js-multistream](https://github.com/diasdavid/js-multistream). | ||
- [ ] Distributed Record Store. [Discussion issue](https://github.com/ipfs/js-ipfs/issues/25). | ||
- [x] [js-ipfs-record](https://github.com/diasdavid/js-ipfs-record) _record (needs MerkleDAG node)_. | ||
- [x] [js-ipfs-distributed-record-store](https://github.com/diasdavid/js-ipfs-distributed-record-store). | ||
- [x] [js-ipfs-kad-record-store](https://github.com/diasdavid/js-ipfs-kad-record-store) _implements abstract record store_. | ||
- [x] [abstract-record-store](https://github.com/diasdavid/abstract-record-store). | ||
- Exchange | ||
- [ ] [node-bitswap](https://github.com/diasdavid/node-bitswap). [Discussion issue](https://github.com/ipfs/node-ipfs/issues/17). | ||
- [ ] [js-bitswap](https://github.com/diasdavid/js-bitswap). [Discussion issue](https://github.com/ipfs/js-ipfs/issues/17). | ||
- MerkleDAG | ||
- [x] MerkleDAG node implementation (needs IPLD). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. would be js instead of node There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. same as #33 (comment) |
||
- [x] [node-ipld](https://github.com/diasdavid/node-ipld). | ||
- [x] [node-merkledag-store](https://github.com/diasdavid/node-merkledag-store). | ||
- [x] [js-ipld](https://github.com/diasdavid/js-ipld). | ||
- [x] [js-merkledag-store](https://github.com/diasdavid/js-merkledag-store). | ||
- Supporting modules | ||
- [ ] [webcrypto](https://github.com/diasdavid/webcrypto). [Discussion issue](https://github.com/ipfs/node-ipfs/issues/27). | ||
- [x] [node-multihash](https://github.com/jbenet/node-multihash). [Discussion issue](https://github.com/ipfs/node-ipfs/issues/26). | ||
- [x] [node-multihashing](https://github.com/jbenet/node-multihashing). [Discussion issue](https://github.com/ipfs/node-ipfs/issues/26). | ||
- [x] [node-multiaddr](https://github.com/jbenet/node-multiaddr). | ||
- [ ] [webcrypto](https://github.com/diasdavid/webcrypto). [Discussion issue](https://github.com/ipfs/js-ipfs/issues/27). | ||
- [x] [js-multihash](https://github.com/jbenet/js-multihash). [Discussion issue](https://github.com/ipfs/js-ipfs/issues/26). | ||
- [x] [js-multihashing](https://github.com/jbenet/js-multihashing). [Discussion issue](https://github.com/ipfs/js-ipfs/issues/26). | ||
- [x] [js-multiaddr](https://github.com/jbenet/js-multiaddr). | ||
- Spec | ||
- [specs/19](https://github.com/ipfs/specs/pull/19). | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"needs MerkleDAG js" I'm guessing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
a MerkleDAG node is an actual 'node' in the sense of a graph. It won't have a module, it is just a JSON blob with some IPLD
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, hence the rename to js makes confusions like this less likely to happen 👍