docs: README refresh, add cli-http-api-core diagram #5396
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ghost
assigned 
Stebalien
reviewed
Aug 22, 2018
| @@ -9,8 +9,6 @@ | |||
| [](https://godoc.org/github.com/ipfs/go-ipfs) | |||
| [](https://travis-ci.org/ipfs/go-ipfs) | |||
|
|
|||
| > IPFS implementation in Go | |||
There was a problem hiding this comment.
I'd leave this (unless there's a good reason to remove it).
There was a problem hiding this comment.
I figure it can't hurt but you're right, it doesn't really have to be there.
README.md
Outdated
|
|
||
| We ❤️ all [our contributors](docs/AUTHORS); this project wouldn’t be what it is without you! If you want to help out, please see [Contribute.md](contribute.md). | ||
| This is a simple description of where the codebase stands. There are multiple subpackages: |
There was a problem hiding this comment.
This is all out of date. We should probably just remove it.
README.md
Outdated
| [](https://github.com/ipfs/community/blob/master/contributing.md) | ||
| - Main file: [cmd/ipfs/main.go](https://github.com/ipfs/go-ipfs/blob/master/cmd/ipfs/main.go) | ||
| - CLI Commands: [core/commands/](https://github.com/ipfs/go-ipfs/tree/master/core/commands) | ||
| - Bitswap (the data trading engine): [exchange/bitswap/](https://github.com/ipfs/go-ipfs/tree/master/exchange/bitswap) |
There was a problem hiding this comment.
License: MIT Signed-off-by: diasdavid <daviddias.p@gmail.com>
License: MIT Signed-off-by: diasdavid <daviddias.p@gmail.com>
And clarify that it's a separate package. License: MIT Signed-off-by: Steven Allen <steven@stebalien.com>
Stebalien
approved these changes
Aug 22, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.