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 d329092 commit 6d6ccb1
Showing 1 changed file with 122 additions and 3 deletions.
125 changes: 122 additions & 3 deletions README.md
Expand Up @@ -24,7 +24,7 @@ Consult the [Roadmap](/ROADMAP.md) for a complete state description of the proje
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 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**. 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.
* **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 @@ -47,13 +47,13 @@ var node = new IPFS()

## Through 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

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

Expand Down Expand Up @@ -173,3 +173,122 @@ Files is the API that lets us work with IPFS objects (DAG Nodes) as if they were
#### Importer

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.

# Usage

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

### Per component view

| Name | Spec | Disc |
| :----| :----| :----|
| data importing | https://github.com/ipfs/specs/pull/57 | https://github.com/ipfs/js-ipfs/issues/41
| repo | https://github.com/ipfs/specs/tree/master/repo | https://github.com/ipfs/js-ipfs/issues/51
| network layer | https://github.com/ipfs/specs/tree/master/libp2p | https://github.com/diasdavid/js-libp2p/issues
| bitswap | https://github.com/ipfs/js-ipfs/issues/51 | https://github.com/ipfs/js-ipfs/issues/51
| pin | | https://github.com/ipfs/js-ipfs/issues/59
| files | | https://github.com/ipfs/js-ipfs/issues/60
| daemon | | https://github.com/ipfs/js-ipfs/issues/57
| object | | https://github.com/ipfs/js-ipfs/issues/58
| block | | https://github.com/ipfs/js-ipfs/issues/50
| bootstrap | | https://github.com/ipfs/js-ipfs/issues/46
| init | | https://github.com/ipfs/js-ipfs/issues/42

### Per feature view

- **core**
- [x] version
- [x] daemon
- [x] id
- [x] block
- [x] get
- [x] put
- [x] stat
- [x] object - Basic manipulation of the DAG
- [x] data
- [x] get
- [x] links
- [x] new
- [x] patch
- [x] put
- [x] stat
- [ ] refs - Listing of references. (alking around the graph)
- [ ] local
- [ ] repo
- [ ] init
- [ ] stat
- [ ] gc
- [ ] pin
- [ ] add
- [ ] ls
- [ ] rm
- [ ] log
- [ ] level
- [ ] tail
- **extensions**
- [ ] name (IPNS)
- [ ] publish
- [ ] resolve
- [ ] dns
- [ ] resolve
- [ ] tar
- [ ] add
- [ ] cat
- [ ] tour
- [ ] list
- [ ] next
- [ ] restart
- [ ] files
- [ ] add
- [ ] cat
- [ ] get
- [ ] stat - Statistics about everything
- [ ] bw
- [ ] mount
- [x] bootstrap
- [x] add
- [x] list
- [x] rm
- [ ] bitswap
- [ ] stat
- [ ] unwant
- [ ] wantlist
- **tooling**
- [ ] commands
- [ ] update
- [ ] init - sugar around ipfs repo init
- [ ] config
- [ ] edit
- [x] replace
- [x] show
- **network** (bubbles up from libp2p)
- [ ] ping
- [ ] dht
- [ ] findpeer
- [ ] findprovs
- [ ] get
- [ ] put
- [ ] query
- [ ] swarm
- [ ] addrs
- [ ] addrs local
- [ ] connect
- [ ] disconnect
- [ ] filters
- [ ] filters add
- [ ] filters rm
- [ ] peers
- [ ] 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 6d6ccb1

Please sign in to comment.