roadmap / readme dont have listing of modules

[jbenet]

the roadmap and readme have feature listings and links to issues, but there isnt a clear listing of all the sub module repos that make up js-ipfs. would be nice to have that list to quickly access those modules

[RichardLitt]

You can get this from npm ls --depth=0. However, this doesn't necessarily help. It would be great if we could highlight which ones we think are important for the Roadmap, and link their repos in a Markdown file. What do you think, @diasdavid?

$ npm ls --depth=0
[email protected] /Users/richard/src/js-ipfs
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected] invalid
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected] invalid
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected] invalid
├── [email protected] invalid
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
└── [email protected]

[dignifiedquire]

That list is not particularly useful as it contains test dependencies as well as helper modules. To get that list it's roughly searching for anything beginning with js- in

• diasdavid
• ipfs
• jbenet

public repos.

[RichardLitt]

Is there any way to narrow down the 'roughly' to something more useful?

[nginnever]

A few modules aren't under daviddias, ipfs, or jbenet as well.

I created a list here that is every module that I know of that is being used by js-ipfs. I am not too sure of the state of libp2p and what js-ipfs is currently depending on so @diasdavid can edit the list as needed.

[dignifiedquire]

thanks a bunch @nginnever I will review it in the morning

[dignifiedquire]

Excellent inspiration on how to do this in the readme:

• https://github.com/cyclejs/cyclejs#packages
• https://github.com/babel/babel#packages