Skip to content
This repository was archived by the owner on Feb 12, 2024. It is now read-only.

Commit b8b3123

Browse files
committed
Added License, Hack section, fixed spelling mistakes, cleaned up Contribute
1 parent 876ab2e commit b8b3123

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,16 @@ js-ipfs
77
88
# Description
99

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).
1111

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.
1313

1414
# Contribute
1515

1616
IPFS implementation in JavaScript is a work in progress. As such, there's a few things you can do right now to help out:
1717

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.
2020
* 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.
2121
* **Add tests**. There can never be enough tests.
2222
* **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()
3939

4040
### Command line tool
4141

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.
4343

4444
```bash
4545
$ npm install ipfs --global
4646
```
4747

48-
The cli is availble through `jsipfs` in your terminal
48+
The cli is available through `jsipfs` in your terminal
4949

5050
# Project structure
5151

@@ -144,7 +144,7 @@ Importer are a set of layouts (e.g. UnixFS) and chunkers (e.g: fixed-size, rabin
144144

145145
# Usage
146146

147-
> This is a WIP, behare of the Dragons!
147+
> This is a WIP, beware of the Dragons!
148148
149149
# Project Status
150150

@@ -251,3 +251,12 @@ Importer are a set of layouts (e.g. UnixFS) and chunkers (e.g: fixed-size, rabin
251251
- [ ] records (IPRS)
252252
- [ ] put
253253
- [ ] get
254+
255+
256+
## License
257+
258+
MIT.
259+
260+
# Want to hack on IPFS?
261+
262+
[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/contributing.md)

0 commit comments

Comments
 (0)