This repository has been archived by the owner on Mar 10, 2020. It is now read-only.
Add current work in progress of readme.md and api.md #102
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.
Closed in favor of #104 that has the branch upstream
This is my current WIP of having a better readme and also added the API docs.
Missing currently:
At first, tried to automatically generate the documentation with a script combining the output of
go-ipfs
and reading the method fingerprint fromjs-ipfs-api
but got a bit stuck and think I tried to overengineer a solution for something that would be simpler to fix manually.Related to #58
Ping @RichardLitt