You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Mar 10, 2020. It is now read-only.
`js-ipfs-api` follows the spec defined by [`interface-ipfs-core`](https://github.com/ipfs/interface-ipfs-core), which governs the interface to expect from IPFS implementations. This interface is an current active endeavour, expect it to be complete in the following weeks (August 2016). You can use it today to consult the methods available.
107
+
`js-ipfs-api` follows the spec defined by [`interface-ipfs-core`](https://github.com/ipfs/interface-ipfs-core), which concerns the interface to expect from IPFS implementations. This interface is a currently active endeavor - expect it to be complete in the next few weeks (August 2016). You can use it today to consult the methods available.
108
108
109
109
### Extra API methods
110
110
111
111
Adding to the methods defined by [`interface-ipfs-core`](https://github.com/ipfs/interface-ipfs-core), `js-ipfs-api` exposes a set of extra utility methods.
112
112
113
-
A complete documentation for these methods is coming with: https://github.com/ipfs/js-ipfs-api/pull/305
113
+
Complete documentation for these methods is coming with: https://github.com/ipfs/js-ipfs-api/pull/305
114
114
115
115
### Callbacks and promises
116
116
@@ -133,15 +133,15 @@ yet available you need to bring your own polyfill.
133
133
134
134
### Testing
135
135
136
-
We run tests by executing `npm test` in a terminal window, this will run both Node.js and Browser tests, both in Chrome and PhantomJS. To ensure that the module conforms with [`interface-ipfs-core`](https://github.com/ipfs/interface-ipfs-core) spec, we run the batch o tests provided by the interface module, which can be found [here](https://github.com/ipfs/interface-ipfs-core/tree/master/src)
136
+
We run tests by executing `npm test` in a terminal window. This will run both Node.js and Browser tests, both in Chrome and PhantomJS. To ensure that the module conforms with the [`interface-ipfs-core`](https://github.com/ipfs/interface-ipfs-core) spec, we run the batch of tests provided by the interface module, which can be found [here](https://github.com/ipfs/interface-ipfs-core/tree/master/src).
137
137
138
138
## Contribute
139
139
140
140
The js-ipfs API is a work in progress. As such, there's a few things you can do right now to help out:
141
141
142
142
***[Check out the existing issues](https://github.com/ipfs/js-ipfs-api/issues)**!
143
143
***Perform code reviews**. More eyes will help a) speed the project along b) ensure quality and c) reduce possible future bugs.
144
-
***Add tests**. There can never be enough tests. Note that interface tests exist inside [`interface-ipfs-core`](https://github.com/ipfs/interface-ipfs-core/tree/master/src)
144
+
***Add tests**. There can never be enough tests. Note that interface tests exist inside [`interface-ipfs-core`](https://github.com/ipfs/interface-ipfs-core/tree/master/src).
145
145
***Contribute to the [FAQ repository](https://github.com/ipfs/faq/issues)** with any questions you have about IPFS or any of the relevant technology. A good example would be asking, 'What is a merkledag tree?'. If you don't know a term, odds are, someone else doesn't either. Eventually, we should have a good understanding of where we need to improve communications and teaching together to make IPFS and IPN better.
0 commit comments