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.
See [API.md](API.md) and [`tests/api`](test/api) for details on available methods.
103
+
### API
104
+
105
+
> `WIP`
106
+
107
+
`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.
108
+
109
+
### Extra API methods
110
+
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
+
113
+
A complete documentation for these methods is coming with: https://github.com/ipfs/js-ipfs-api/pull/305
114
+
115
+
#### `ipfs.util.addURL`
116
+
117
+
`...`
118
+
119
+
#### `ipfs.util.addFiles`
120
+
121
+
`...`
122
+
123
+
### `ipfs.util.addStream`
124
+
125
+
`...`
103
126
104
127
### Callbacks and promises
105
128
@@ -118,13 +141,19 @@ ipfs.id()
118
141
This relies on a global `Promise` object. If you are in an environment where that is not
119
142
yet available you need to bring your own polyfill.
120
143
144
+
## Development
145
+
146
+
### Testing
147
+
148
+
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)
149
+
121
150
## Contribute
122
151
123
152
The js-ipfs API is a work in progress. As such, there's a few things you can do right now to help out:
124
153
125
154
***[Check out the existing issues](https://github.com/ipfs/js-ipfs-api/issues)**!
126
155
***Perform code reviews**. More eyes will help a) speed the project along b) ensure quality and c) reduce possible future bugs.
127
-
***Add tests**. There can never be enough tests.
156
+
***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)
128
157
***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