@@ -47,9 +47,6 @@ $ npm i ipfs -g
4747
4848The cli is availble through ` jsipfs ` in your terminal
4949
50- ### API
51-
52-
5350# Project structure
5451
5552```
@@ -64,130 +61,123 @@ The cli is availble through `jsipfs` in your terminal
6461 └─────┘
6562```
6663
67- # Roadmap for the full IPFS implementation in JavaScript
68-
69- - ** Network layer**
70- - The network layer of IPFS is now known as libp2p, follow https://github.com/diasdavid/js-libp2p
71- - ** Exchange**
72- - [ ] [ js-bitswap] ( https://github.com/diasdavid/js-bitswap ) . [ ![ ] ( https://img.shields.io/badge/discuss--blue.svg?style=flat-square )] ( https://github.com/ipfs/js-ipfs/issues/17 ) ![ ] ( https://img.shields.io/badge/status-has%20not%20started%20yet-brown.svg?style=flat-square )
73- - [ ] [ js-ipfs-repo] ( https://github.com/ipfs/js-ipfs-repo )
74- - [ ] [ keys] ( https://github.com/ipfs/js-ipfs-repo/issues/4 )
75- - [ ] [ version] ( https://github.com/ipfs/js-ipfs-repo/issues/5 )
76- - [ ] [ datastore] ( https://github.com/ipfs/js-ipfs-repo/issues/6 )
77- - [ ] [ config] ( https://github.com/ipfs/js-ipfs-repo/issues/7 )
78- - [ ] [ logs] ( https://github.com/ipfs/js-ipfs-repo/issues/8 )
79- - [ ] [ locks] ( https://github.com/ipfs/js-ipfs-repo/issues/9 )
80- - [x] MerkleDAG node implementation (needs IPLD).
81- - [ js-ipld] ( https://github.com/diasdavid/js-ipld ) ![ ] ( https://img.shields.io/badge/status-in%20progress-yellow.svg?style=flat-square )
82- - [ ] Update to latest version of IPLD
83- - [ js-merkledag-store] ( https://github.com/diasdavid/js-merkledag-store ) ![ ] ( https://img.shields.io/badge/status-in%20progress-yellow.svg?style=flat-square )
84- - [ ] Update to be mounted on top of js-ipfs-repo
85- - [ Data Importing] ( https://github.com:diasdavid/js-ipfs-data-importing )
86- - [ ] spec - https://github.com/ipfs/specs/pull/57/files
87- - [ ] importer interface
88- - [ ] fixed sized chunks
89- - [ ] jsipfs tar
90- - [ ] rabin fingerprinting
91- - [ ] js-ipfs [ follow the roadmap] ( https://github.com/ipfs/pm/blob/js-ipfs/roadmap/ROADMAP.js-ipfs.md )
92- - ** Commands**
93- - core
94- - version
95- - node
96- - id
97- - start
98- - stop
99- - block
100- - get
101- - put
102- - stat
103- - object - Basic manipulation of the DAG
104- - data
105- - get
106- - links
107- - new
108- - patch
109- - put
110- - stat
111- - refs - Listing of references. (Essentially, walking around the graph).
112- - local
113- - repo - Basic manipulation of the repo
114- - init
115- - stat
116- - gc
117- - config get
118- - config put
119- - pin - Basic manipulation of the pin set
120- - add
121- - ls
122- - rm
123- - log
124- - level
125- - tail
126- - name (ipns)
127- - name publish
128- - resolve
129- - extensions
130- - dns
131- - resolve
132- - tar
133- - add
134- - cat
135- - tour
136- - list
137- - next
138- - restart
139- - files
140- - add
141- - cat
142- - get
143- - stat - Statistics about everything
144- - bw
145- - mount
146- - bootstrap
147- - add
148- - list
149- - rm
150- - tools
151- - commands
152- - update
153- - init - sugar around ipfs repo init
154- - config
155- - edit
156- - replace
157- - show
158- - daemon
159- - diag
160- - net
161- - sys
162- - libp2p (exposed by libp2p)
163- - ping
164- - dht
165- - findpeer
166- - findprovs
167- - get
168- - put
169- - query
170- - swarm
171- - addrs
172- - addrs local
173- - connect
174- - disconnect
175- - filters
176- - filters add
177- - filters rm
178- - peers
179- - record (IPRS)
180- - put
181- - get
182- - bitswap
183- - stat
184- - unwant
185- - wantlist
186- - [ ** Spec** ] ( https://github.com/ipfs/specs/tree/master/protocol/network ) ![ ] ( https://img.shields.io/badge/status-in%20progress-yellow.svg?style=flat-square )
187-
188- ### status badges
189-
190- - ![ ] ( https://img.shields.io/badge/status-has%20not%20started%20yet-brown.svg?style=flat-square )
191- - ![ ] ( https://img.shields.io/badge/status-in%20progress-yellow.svg?style=flat-square )
192- - ![ ] ( https://img.shields.io/badge/status-ready-green.svg?style=flat-square )
193- - [ ![ ] ( https://img.shields.io/badge/discuss--blue.svg?style=flat-square )] (LINK HERE)
64+ # Usage
65+
66+ > WIP
67+
68+ # Project Status
69+
70+ ### Per component view
71+
72+ - ** Network layer** - See hhttps://github.com/diasdavid/js-libp2p
73+ - ipfs-repo - [ spec] ( https://github.com/ipfs/specs/tree/master/repo ) - [ impl] ( https://github.com/ipfs/js-ipfs-repo )
74+ - keys
75+ - version
76+ - datastore.legacy
77+ - datastore
78+ - config
79+ - logs
80+ - locks
81+ - ipfs-data-importing - [ spec] ( https://github.com/ipfs/specs/pull/57 ) - [ impl] ( https://github.com/ipfs/js-ipfs-data-importing )
82+ - fixed size chunker
83+ - rabin chunking
84+ - tar importer
85+ - MerkleDAG layout (protobufs)
86+ - IPLD layout (json + cbor)
87+ - bitswap - [ spec] ( https://github.com/ipfs/specs/pull/53 ) - [ impl] ( https://github.com/ipfs/js-ipfs-bitswap )
88+
89+ ### Per feature view
90+
91+ - ** core**
92+ - [x] version
93+ - [ ] node (previously known as daemon)
94+ - [x] id
95+ - [ ] start
96+ - [ ] stop
97+ - [ ] block
98+ - [ ] get
99+ - [ ] put
100+ - [ ] stat
101+ - [ ] object - Basic manipulation of the DAG
102+ - [ ] data
103+ - [ ] get
104+ - [ ] links
105+ - [ ] new
106+ - [ ] patch
107+ - [ ] put
108+ - [ ] stat
109+ - [ ] refs - Listing of references. (alking around the graph)
110+ - [ ] local
111+ - [ ] repo
112+ - [ ] init
113+ - [ ] stat
114+ - [ ] gc
115+ - [ ] config get
116+ - [ ] config put
117+ - [ ] pin
118+ - [ ] add
119+ - [ ] ls
120+ - [ ] rm
121+ - [ ] log
122+ - [ ] level
123+ - [ ] tail
124+ - ** extensions**
125+ - [ ] name (IPNS)
126+ - [ ] publish
127+ - [ ] resolve
128+ - [ ] dns
129+ - [ ] resolve
130+ - [ ] tar
131+ - [ ] add
132+ - [ ] cat
133+ - [ ] tour
134+ - [ ] list
135+ - [ ] next
136+ - [ ] restart
137+ - [ ] files
138+ - [ ] add
139+ - [ ] cat
140+ - [ ] get
141+ - [ ] stat - Statistics about everything
142+ - [ ] bw
143+ - [ ] mount
144+ - [x] bootstrap
145+ - [x] add
146+ - [x] list
147+ - [x] rm
148+ - [ ] bitswap
149+ - [ ] stat
150+ - [ ] unwant
151+ - [ ] wantlist
152+ - ** tooling**
153+ - [ ] commands
154+ - [ ] update
155+ - [ ] init - sugar around ipfs repo init
156+ - [ ] config
157+ - [ ] edit
158+ - [ ] replace
159+ - [ ] show
160+ - [ ] daemon
161+ - [ ] diag
162+ - [ ] net
163+ - [ ] sys
164+ - ** network** (bubbles up from libp2p)
165+ - [ ] ping
166+ - [ ] dht
167+ - [ ] findpeer
168+ - [ ] findprovs
169+ - [ ] get
170+ - [ ] put
171+ - [ ] query
172+ - [ ] swarm
173+ - [ ] addrs
174+ - [ ] addrs local
175+ - [ ] connect
176+ - [ ] disconnect
177+ - [ ] filters
178+ - [ ] filters add
179+ - [ ] filters rm
180+ - [ ] peers
181+ - [ ] records (IPRS)
182+ - [ ] put
183+ - [ ] get
0 commit comments