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

Commit 6d6ccb1

Browse files
committed
Added License, Hack section, fixed spelling mistakes, cleaned up Contribute
1 parent d329092 commit 6d6ccb1

File tree

1 file changed

+122
-3
lines changed

1 file changed

+122
-3
lines changed

README.md

+122-3
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,122 @@ 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+
# Usage
178+
179+
> This is a WIP, beware of the Dragons!
180+
181+
# Project Status
182+
183+
### Per component view
184+
185+
| Name | Spec | Disc |
186+
| :----| :----| :----|
187+
| data importing | https://github.com/ipfs/specs/pull/57 | https://github.com/ipfs/js-ipfs/issues/41
188+
| repo | https://github.com/ipfs/specs/tree/master/repo | https://github.com/ipfs/js-ipfs/issues/51
189+
| network layer | https://github.com/ipfs/specs/tree/master/libp2p | https://github.com/diasdavid/js-libp2p/issues
190+
| bitswap | https://github.com/ipfs/js-ipfs/issues/51 | https://github.com/ipfs/js-ipfs/issues/51
191+
| pin | | https://github.com/ipfs/js-ipfs/issues/59
192+
| files | | https://github.com/ipfs/js-ipfs/issues/60
193+
| daemon | | https://github.com/ipfs/js-ipfs/issues/57
194+
| object | | https://github.com/ipfs/js-ipfs/issues/58
195+
| block | | https://github.com/ipfs/js-ipfs/issues/50
196+
| bootstrap | | https://github.com/ipfs/js-ipfs/issues/46
197+
| init | | https://github.com/ipfs/js-ipfs/issues/42
198+
199+
### Per feature view
200+
201+
- **core**
202+
- [x] version
203+
- [x] daemon
204+
- [x] id
205+
- [x] block
206+
- [x] get
207+
- [x] put
208+
- [x] stat
209+
- [x] object - Basic manipulation of the DAG
210+
- [x] data
211+
- [x] get
212+
- [x] links
213+
- [x] new
214+
- [x] patch
215+
- [x] put
216+
- [x] stat
217+
- [ ] refs - Listing of references. (alking around the graph)
218+
- [ ] local
219+
- [ ] repo
220+
- [ ] init
221+
- [ ] stat
222+
- [ ] gc
223+
- [ ] pin
224+
- [ ] add
225+
- [ ] ls
226+
- [ ] rm
227+
- [ ] log
228+
- [ ] level
229+
- [ ] tail
230+
- **extensions**
231+
- [ ] name (IPNS)
232+
- [ ] publish
233+
- [ ] resolve
234+
- [ ] dns
235+
- [ ] resolve
236+
- [ ] tar
237+
- [ ] add
238+
- [ ] cat
239+
- [ ] tour
240+
- [ ] list
241+
- [ ] next
242+
- [ ] restart
243+
- [ ] files
244+
- [ ] add
245+
- [ ] cat
246+
- [ ] get
247+
- [ ] stat - Statistics about everything
248+
- [ ] bw
249+
- [ ] mount
250+
- [x] bootstrap
251+
- [x] add
252+
- [x] list
253+
- [x] rm
254+
- [ ] bitswap
255+
- [ ] stat
256+
- [ ] unwant
257+
- [ ] wantlist
258+
- **tooling**
259+
- [ ] commands
260+
- [ ] update
261+
- [ ] init - sugar around ipfs repo init
262+
- [ ] config
263+
- [ ] edit
264+
- [x] replace
265+
- [x] show
266+
- **network** (bubbles up from libp2p)
267+
- [ ] ping
268+
- [ ] dht
269+
- [ ] findpeer
270+
- [ ] findprovs
271+
- [ ] get
272+
- [ ] put
273+
- [ ] query
274+
- [ ] swarm
275+
- [ ] addrs
276+
- [ ] addrs local
277+
- [ ] connect
278+
- [ ] disconnect
279+
- [ ] filters
280+
- [ ] filters add
281+
- [ ] filters rm
282+
- [ ] peers
283+
- [ ] records (IPRS)
284+
- [ ] put
285+
- [ ] get
286+
287+
288+
## License
289+
290+
MIT.
291+
292+
# Want to hack on IPFS?
293+
294+
[![](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)