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

Commit b7a364b

Browse files
committed
Merge pull request #212 from ipfs/feature/spruce-up-readme
Added License, Hack section, fixed spelling mistakes, cleaned up Cont…
2 parents d329092 + 4923331 commit b7a364b

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Consult the [Roadmap](/ROADMAP.md) for a complete state description of the proje
2424
IPFS implementation in JavaScript is a work in progress. As such, there's a few things you can do right now to help out:
2525

2626
* 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.
2828
* 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.
2929
* **Add tests**. There can never be enough tests.
3030
* **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()
4747

4848
## Through command line tool
4949

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

5252
```bash
5353
$ npm install ipfs --global
5454
```
5555

56-
The cli is availble through `jsipfs` in your terminal
56+
The cli is available through `jsipfs` in your terminal
5757

5858
## Use in the browser with browserify, webpack or any bundler
5959

@@ -173,3 +173,11 @@ Files is the API that lets us work with IPFS objects (DAG Nodes) as if they were
173173
#### Importer
174174

175175
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+
## License
178+
179+
MIT.
180+
181+
# Want to hack on IPFS?
182+
183+
[![](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)