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.
This repo contains the JavaScript implementation of the IPFS protocol, with feature parity to the [Go implementation](https://github.com/ipfs/go-ipfs).
20
17
21
-
# Project status
18
+
###Project status
22
19
23
20
Consult the [Roadmap](/ROADMAP.md) for a complete state description of the project, or you can find `in process` updates in our [`Captain.log`](https://github.com/ipfs/js-ipfs/issues/30). A lot of components can be used currently, but it is a WIP, so beware of the Dragons.
IPFS implementation in JavaScript is a work in progress. As such, there's a few things you can do right now to help out:
30
-
31
-
* 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.
32
-
***Perform code reviews**. More eyes will help a) speed the project along b) ensure quality and c) reduce possible future bugs.
33
-
* 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.
34
-
***Add tests**. There can never be enough tests.
35
-
***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.
36
-
37
-
# Installation
38
-
39
-
## npm
24
+
## Table of Contents
25
+
26
+
-[Install](#install)
27
+
-[npm](#npm)
28
+
-[Use in Node.js](#use-in-nodejs)
29
+
-[Through command line tool](#through-command-line-tool)
30
+
-[Use in the browser with browserify, webpack or any bundler](#use-in-the-browser-with-browserify-webpack-or-any-bundler)
31
+
-[Use in a browser using a script tag](#use-in-a-browser-using-a-script-tag)
This project is available through [npm](https://www.npmjs.com/). To install:
40
53
41
54
```bash
42
-
$ npm i ipfs --save
55
+
$ npm install ipfs --save
43
56
```
44
57
45
-
## Use in Node.js
58
+
### Use in Node.js
59
+
60
+
To include this project programmatically:
46
61
47
62
```js
48
63
varIPFS=require('ipfs')
49
64
50
65
var node =newIPFS()
51
66
```
52
67
53
-
## Through command line tool
68
+
###Through command line tool
54
69
55
-
In order to use js-ipfs as a CLI, you must install it with the `global` flag.
70
+
In order to use js-ipfs as a CLI, you must install it with the `global` flag. Run the following (even if you have ipfs installed locally):
56
71
57
72
```bash
58
73
$ npm install ipfs --global
59
74
```
60
75
61
-
The cli is available through `jsipfs` in your terminal
76
+
The CLI is available by using the command `jsipfs` in your terminal. This is aliased, instead of using `ipfs`, to make sure it does not conflict with the Go implementation.
62
77
63
-
## Use in the browser with browserify, webpack or any bundler
78
+
###Use in the browser with browserify, webpack or any bundler
64
79
65
-
The code published to npm that gets loaded on require is in fact a ES5 transpiled version with the right shims added. This means that you can require it and use with your favourite bundler without having to adjust asset management process.
80
+
The code published to npm that gets loaded on require is in fact a ES5 transpiled version with the right shims added. This means that you can require it and use with your favourite bundler without having to adjust the asset management process.
66
81
67
-
```js
68
-
```
82
+
### Use in a browser using a script tag
69
83
70
-
## Use in a browser using a script tag
84
+
Simply include ipfs in your bundled javascript file.
@@ -98,7 +111,7 @@ The code published to npm that gets loaded on require is in fact a ES5 transpile
98
111
└─────┘
99
112
```
100
113
101
-
# IPFS Core Implementation Architecture
114
+
##IPFS Core implementation architecture
102
115
103
116
IPFS Core is divided into separate subsystems, each of them exist in their own repo/module. The dependencies between each subsystem is assured by injection at the IPFS Core level. IPFS Core exposes an API, defined by the IPFS API spec. libp2p is the networking layer used by IPFS, but out of scope in IPFS core, follow that project [here](https://github.com/diasdavid/js-libp2p)
104
117
@@ -179,10 +192,21 @@ Files is the API that lets us work with IPFS objects (DAG Nodes) as if they were
179
192
180
193
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.
181
194
182
-
## License
183
195
184
-
MIT.
196
+
## Contribute
185
197
186
-
# Want to hack on IPFS?
198
+
IPFS implementation in JavaScript is a work in progress. As such, there's a few things you can do right now to help out:
199
+
200
+
* 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.
201
+
***Perform code reviews**. More eyes will help a) speed the project along b) ensure quality and c) reduce possible future bugs.
202
+
* 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.
203
+
***Add tests**. There can never be enough tests.
204
+
***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