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 Feb 12, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+122-3
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,7 @@ Consult the [Roadmap](/ROADMAP.md) for a complete state description of the proje
24
24
IPFS implementation in JavaScript is a work in progress. As such, there's a few things you can do right now to help out:
25
25
26
26
* Go through the modules below and **check out existing issues**. This would be especially useful for modules in active development. Some knowledge of IPFS may be required, as well as the infrastructure behind it - for instance, you may need to read up on p2p and more complex operations like muxing to be able to help technically.
27
-
***Perform code reviews**. Most of this has been developed by @diasdavid, which means that more eyes will help a) speed the project along b) ensure quality and c) reduce possible future bugs.
27
+
***Perform code reviews**. More eyes will help a) speed the project along b) ensure quality and c) reduce possible future bugs.
28
28
* Take a look at go-ipfs and some of the planning repositories or issues: for instance, the libp2p spec [here](https://github.com/ipfs/specs/pull/19). Contributions here that would be most helpful are **top-level comments** about how it should look based on our understanding. Again, the more eyes the better.
29
29
***Add tests**. There can never be enough tests.
30
30
***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.
@@ -47,13 +47,13 @@ var node = new IPFS()
47
47
48
48
## Through command line tool
49
49
50
-
In order to use js-ipfs as a CLI, you must install it with the -g flag.
50
+
In order to use js-ipfs as a CLI, you must install it with the `global` flag.
51
51
52
52
```bash
53
53
$ npm install ipfs --global
54
54
```
55
55
56
-
The cli is availble through `jsipfs` in your terminal
56
+
The cli is available through `jsipfs` in your terminal
57
57
58
58
## Use in the browser with browserify, webpack or any bundler
59
59
@@ -173,3 +173,122 @@ Files is the API that lets us work with IPFS objects (DAG Nodes) as if they were
173
173
#### Importer
174
174
175
175
Importer are a set of layouts (e.g. UnixFS) and chunkers (e.g: fixed-size, rabin, etc) that convert data to a MerkleDAG representation inside IPFS.
176
+
177
+
# Usage
178
+
179
+
> This is a WIP, beware of the Dragons!
180
+
181
+
# Project Status
182
+
183
+
### Per component view
184
+
185
+
| Name | Spec | Disc |
186
+
| :----| :----| :----|
187
+
| data importing | https://github.com/ipfs/specs/pull/57 | https://github.com/ipfs/js-ipfs/issues/41
0 commit comments