I think this project need a api-doc

Question

I think this project need a api-doc

osdio opened this issue 9 years ago · 10 comments

Good job,
This is a nice project, But I find that there are no api-doc. Can you write a api-doc?

good job

Answer 1 · 2016-01-25T06:09:15.000Z

Yes, there will be a lot of documentation soon. I am currently breaking out the codebase into smaller modules, which are each getting detailed docs. I will comment in this issue when most of the big components are documented. 😄

Answer 2 · 2016-01-25T06:12:57.000Z

And I have a question:

Can you make the module support browser , node.js and react-native at the same time?

I know that now it support browser and node.js, but I think you can also support the react-native. You can consider this project : https://github.com/oney/react-native-webrtc

Answer 3 · 2016-01-25T08:05:14.000Z

Sure, I'll keep React Native in mind and ensure compatibility. Thanks for letting me know about that module 👍

Answer 4 · 2016-01-25T08:13:22.000Z

Ok, When you finish , I am considering using this module to build a react-native app for bitcoin. I am waiting for your new module. 👍

Answer 5 · 2016-02-02T07:40:52.000Z

@mappum can I help at all with refactoring or documenting? I think I could figure out Webcoin enough to write some simple documentation.

Answer 6 · 2016-02-02T08:54:27.000Z

@paulkernfeld Sure! It would be helpful if you browse the repos listed in the README and make sure the documentation I have written so far is clear enough. Beyond that, you could join #webcoin on Freenode to discuss the refactoring.

Answer 7 · 2016-02-29T14:43:20.000Z

Have you guys considered supporting the https://github.com/blockai/abstract-common-blockchain and https://github.com/blockai/abstract-common-wallet APIs? This might additionally ease documentation and interface choices.

Answer 8 · 2016-02-29T17:59:24.000Z

@xloem I've seen those and they are a good idea. We could easily make a
module that wraps the Webcoin API to provide the common-X APIs.
On Feb 29, 2016 6:43 AM, "xloem" notifications@github.com wrote:

Have you guys considered supporting the
https://github.com/blockai/abstract-common-blockchain and
https://github.com/blockai/abstract-common-wallet APIs? This might
additionally ease documentation and interface choices.

—
Reply to this email directly or view it on GitHub
#3 (comment).

Answer 9 · 2016-05-12T01:05:35.000Z

Webcoin has now been broken up into modules, each with their own documentation. See the README for a list.