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
+16-7Lines changed: 16 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,16 +7,16 @@ js-ipfs
7
7
8
8
# Description
9
9
10
-
This repo will contain the entry point for the JavaScript implementation of IPFS spec, similar to [go-ipfs](https://github.com/ipfs/go-ipfs).
10
+
This repository will contain the entry point for the JavaScript implementation of IPFS spec, similar to [go-ipfs](https://github.com/ipfs/go-ipfs).
11
11
12
-
We are building js-ipfs because it will inform how go-ipfs works, separate concerns, and allow a complete in-browser-tab implementation with no install friction. Most of the work for IPFS does happen elsewhere, but this is an equally important part of our roadmap to lead to a permanent, IPFSed web.
12
+
We are building js-ipfs because it will inform how go-ipfs works, separate concerns, and allow a complete in-browser-tab implementation with no install friction. Most of the work for IPFS does happen elsewhere, but this is an equally important part of our road-map to lead to a permanent, IPFSed web.
13
13
14
14
# Contribute
15
15
16
16
IPFS implementation in JavaScript is a work in progress. As such, there's a few things you can do right now to help out:
17
17
18
-
* 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 infrasture behind it - for instance, you may need to read up on p2p and more complex operations like muxing to be able to help technically.
19
-
***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.
18
+
* 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.
19
+
***Perform code reviews**. More eyes will help a) speed the project along b) ensure quality and c) reduce possible future bugs.
20
20
* 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.
21
21
***Add tests**. There can never be enough tests.
22
22
***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.
@@ -39,13 +39,13 @@ var node = new IPFS()
39
39
40
40
### Command line tool
41
41
42
-
In order to use js-ipfs as a CLI, you must install it with the -g flag.
42
+
In order to use js-ipfs as a CLI, you must install it with the `global` flag.
43
43
44
44
```bash
45
45
$ npm install ipfs --global
46
46
```
47
47
48
-
The cli is availble through `jsipfs` in your terminal
48
+
The cli is available through `jsipfs` in your terminal
49
49
50
50
# Project structure
51
51
@@ -144,7 +144,7 @@ Importer are a set of layouts (e.g. UnixFS) and chunkers (e.g: fixed-size, rabin
144
144
145
145
# Usage
146
146
147
-
> This is a WIP, behare of the Dragons!
147
+
> This is a WIP, beware of the Dragons!
148
148
149
149
# Project Status
150
150
@@ -251,3 +251,12 @@ Importer are a set of layouts (e.g. UnixFS) and chunkers (e.g: fixed-size, rabin
0 commit comments