Skip to content
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

Closed
wants to merge 1 commit into from
Closed

Add current work in progress of readme.md and api.md #102

wants to merge 1 commit into from

Conversation

victorb
Copy link
Contributor

@victorb victorb commented Nov 3, 2015

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:

  • Examples of all the calls
  • Better description of how to use the methods
  • Probably update the TOC
  • Check links et al
  • Proofread

At first, tried to automatically generate the documentation with a script combining the output of go-ipfs and reading the method fingerprint from js-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

@daviddias
Copy link
Contributor

It would be sweet to list also the options for each call :)

@RichardLitt
Copy link
Contributor

Hmm. Is there any way I can edit this? I can't commit on top of your fork's branch. Could you add this as a branch on ipfs's remote?

@daviddias
Copy link
Contributor

@victorbjelkholm you have write access to js-ipfs-api repo, you can create a branch on the main repo directly so that everyone can collab :), makes it easier and faster.

@victorb
Copy link
Contributor Author

victorb commented Nov 6, 2015

@RichardLitt @diasdavid sorry about that, have made a new PR with a branch that is here in upstream. #104

@victorb victorb closed this Nov 6, 2015
@jbenet
Copy link
Contributor

jbenet commented Nov 8, 2015

as you go, consider contributing to

@RichardLitt RichardLitt mentioned this pull request Nov 9, 2015
11 tasks
@daviddias daviddias mentioned this pull request Nov 10, 2015
42 tasks
@RichardLitt RichardLitt mentioned this pull request Nov 16, 2015
53 tasks
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants