README.md: Notes on where to start reading code
Based on response from @whyrusleeping. (https://github.com/ipfs/go-ipfs/issues/4048#issuecomment-313774707) License: MIT Signed-off-by: Jon Choi <choi.jonathanh@gmail.com>
Jon Choi committed
Jul 7, 2017 at 15:41 UTC
f7883ed1b3c2cd799035e7b79f2c47f2ebc98e2a
1 file changed
+13
README.md
+13
@@ -44,6 +44,7 @@ Please put all issues regarding the Go IPFS _implementation_ in [this repo](http
44
- [Todo](#todo)
45
- [Contributing](#contributing)
46
- [Want to hack on IPFS?](#want-to-hack-on-ipfs)
47
+ - [Want to read our code?](#want-to-read-our-code)
48
- [License](#license)
49
50
## Security Issues
@@ -307,6 +308,18 @@ This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/c
308
309
[](https://github.com/ipfs/community/blob/master/contributing.md)
310
311
+### Want to read our code?
312
+
313
+Some places to get you started. (WIP)
314
+
315
+Main file: [cmd/ipfs/main.go](https://github.com/ipfs/go-ipfs/blob/master/cmd/ipfs/main.go) <br>
316
+CLI Commands: [core/commands/](https://github.com/ipfs/go-ipfs/tree/master/core/commands) <br>
317
+Bitswap (the data trading engine): [exchange/bitswap/](https://github.com/ipfs/go-ipfs/tree/master/exchange/bitswap)
318
+
319
+DHT: https://github.com/libp2p/go-libp2p-kad-dht <br>
320
+PubSub: https://github.com/libp2p/go-floodsub <br>
321
+libp2p: https://github.com/libp2p/go-libp2p
322
+
323
## License
324
325
MIT