Skip to content

docs: README refresh, add cli-http-api-core diagram - #5396

Merged
Stebalien merged 3 commits into
masterfrom
docs-update
Aug 23, 2018
Merged

Stebalien merged 3 commits into
masterfrom
docs-update

Conversation

@daviddias

Copy link
Copy Markdown
Member

No description provided.

Comment thread README.md
[![GoDoc](https://godoc.org/github.com/ipfs/go-ipfs?status.svg)](https://godoc.org/github.com/ipfs/go-ipfs)
[![Build Status](https://travis-ci.org/ipfs/go-ipfs.svg?branch=master)](https://travis-ci.org/ipfs/go-ipfs)

> IPFS implementation in Go

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd leave this (unless there's a good reason to remove it).

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't it obvious?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I figure it can't hurt but you're right, it doesn't really have to be there.

Comment thread README.md Outdated
## Development

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:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is all out of date. We should probably just remove it.

Comment thread README.md Outdated
[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](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)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ghost ghost assigned Stebalien Aug 22, 2018
daviddias and others added 3 commits August 22, 2018 16:09
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
Stebalien merged commit 4b4bdf4 into master Aug 23, 2018
@ghost ghost removed the status/in-progress In progress label Aug 23, 2018
@Stebalien
Stebalien deleted the docs-update branch August 23, 2018 00:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants