What does js-multiaddr do?

Question

What does js-multiaddr do?

Closed this issue 9 years ago · 2 comments

It's not clear from the first textful of README what js-multiaddr does. It's an implementation of multiaddr, but what does that mean? The README should ideally aim to very quickly answer the question "what are the inputs and outputs of this module", or "what does this module do"?

Answer 1 · 2016-04-18T12:24:08.000Z

Do you still have this question, @noffle ?

Answer 2 · 2016-04-18T23:43:51.000Z

I think it's enough for js-multiaddr to state itself as a JS impl of multiaddr, but we could definitely use more doc <3 on jbenet/multiaddr for brand new users unfamiliar with the big ideas of multiaddr. Let's close this and focus efforts over there. (see multiformats/multiaddr#13)