Added Contribute, License, and Banner #268
Conversation
Related to #152
…t Contribute, fixed a couple of grammar things Related to #152
| @@ -18,6 +18,24 @@ IPFS API wrapper library in JavaScript | |||
| $ npm install --save ipfs-api | |||
| ``` | |||
|
|
|||
| #### Running the daemon with the right port | |||
|
|
|||
| To interact with the API, you need to have a local daemon running (at the moment; we have plans to make it work independently). It needs to be open on the right port: `5001`. This is the default. | |||
There was a problem hiding this comment.
local daemon running (at the moment; we have plans to make it work independently
What do you have in mind?
It needs to be open on the right port:
5001. This is the default.
The default port is 5001, but it can open any really, if the user changes the default port, then it has to change the port in the example too :)
|
Thank you @RichardLitt :) CR'ed |
|
@RichardLitt why did you move the promise vs callback into the readme? It's part of the API description |
|
Yeah, I understand that. I did it that section should apply to the entire repository, and I think it needs a higher visibility. The API.md file should be in the Readme, I think; it is more cohesive as a file on it's own without extra information like callbacks or promises. Does that make sense? |
Related to #152