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

Commit

Permalink
Added License, Hack section, fixed spelling mistakes, cleaned up Cont…
Browse files Browse the repository at this point in the history
…ribute
  • Loading branch information
RichardLitt committed May 11, 2016
1 parent 876ab2e commit b8b3123
Showing 1 changed file with 16 additions and 7 deletions.
23 changes: 16 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@ js-ipfs
# Description

This repo will contain the entry point for the JavaScript implementation of IPFS spec, similar to [go-ipfs](https://github.com/ipfs/go-ipfs).
This repository will contain the entry point for the JavaScript implementation of IPFS spec, similar to [go-ipfs](https://github.com/ipfs/go-ipfs).

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

# Contribute

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

* 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.
* **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.
* 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.
* **Perform code reviews**. More eyes will help a) speed the project along b) ensure quality and c) reduce possible future bugs.
* 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.
* **Add tests**. There can never be enough tests.
* **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.
Expand All @@ -39,13 +39,13 @@ var node = new IPFS()

### Command line tool

In order to use js-ipfs as a CLI, you must install it with the -g flag.
In order to use js-ipfs as a CLI, you must install it with the `global` flag.

```bash
$ npm install ipfs --global
```

The cli is availble through `jsipfs` in your terminal
The cli is available through `jsipfs` in your terminal

# Project structure

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

# Usage

> This is a WIP, behare of the Dragons!
> This is a WIP, beware of the Dragons!
# Project Status

Expand Down Expand Up @@ -251,3 +251,12 @@ Importer are a set of layouts (e.g. UnixFS) and chunkers (e.g: fixed-size, rabin
- [ ] records (IPRS)
- [ ] put
- [ ] get


## License

MIT.

# Want to hack on IPFS?

[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/contributing.md)

0 comments on commit b8b3123

Please sign in to comment.