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.
This pull request completely trashes the README.md file for this repository.
But only because, for better or worse, the API documentation for the current version of this library is—quite frankly—trash.
However, I think we can and should definitely improve it. Perhaps, if people are forced to look at it, they will be more motivated to update and improve it.
I don't know if we should merge this into master now, or keep it in its own branch until after the documentation can be improved. It will be a massive effort, but if we want people to upgrade from
bsv@^1.5.5
it will need to be done.While I am happy to help with the documentation effort itself as I have the time, I lack intimate familiarity with this library, and have yet to use it in my applications (due to lack of quality documentation). While the code for
bsv@2
might be 1,000 times better thanbsv@1
, my view is that this does not matter until people can reference and use it. One of the reasons I usebsv@1
is because I can simply visit docs.moneybutton.com and see all the great examples.Thoughts and improvements welcome. We should discuss whether it makes sense to merge this now, or keep it on its own branch until the documentation effort moves forward.