Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleaned up README #2302

Merged
merged 1 commit into from
Feb 5, 2016
Merged

Conversation

RichardLitt
Copy link
Member

I did the following:

  • Capitalized IPFS wherever it did not explicitely refer to the CLI command
  • Moved Dev Dependencies into the Install section
  • Added a Table of Contents
  • Capitalised and added periods to various sentences
  • Capitalised Go
  • Removed double empty lines
  • Reindented a few sections to make the flow more clear.
  • Added a note to the Install section about how to canonically install.

License: MIT
Signed-off-by: Richard Littauer richard.littauer@gmail.com

@RichardLitt RichardLitt added topic/docs-ipfs Topic docs-ipfs need/review Needs a review labels Feb 5, 2016
@RichardLitt RichardLitt force-pushed the feature/gx-libp2p-readme-edits branch 2 times, most recently from 80a93be to e704c36 Compare February 5, 2016 15:22
- [Troubleshooting](#troubleshooting)
- [Contributing](#contributing)
- [Todo](#todo)
- [License](#license)
Copy link

Choose a reason for hiding this comment

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

👍 for table of contents

@ghost
Copy link

ghost commented Feb 5, 2016

Generally 👍

I did the following:
- Capitalized IPFS wherever it did not explicitely refer to the CLI command
- Moved Dev Dependencies into the Install section
- Added a Table of Contents
- Capitalised and added periods to various sentences
- Capitalised Go
- Removed double empty lines
- Reindented a few sections to make the flow more clear.
- Added a note to the Install section about how to canonically install.

License: MIT
Signed-off-by: Richard Littauer <richard.littauer@gmail.com>
@whyrusleeping
Copy link
Member

Cool, this looks good to me

whyrusleeping added a commit that referenced this pull request Feb 5, 2016
@whyrusleeping whyrusleeping merged commit ffc4831 into feat/gx-libp2p Feb 5, 2016
@whyrusleeping whyrusleeping deleted the feature/gx-libp2p-readme-edits branch February 5, 2016 20:30
@@ -96,7 +120,7 @@ USAGE:
BASIC COMMANDS

init Initialize ipfs local configuration
add <path> Add a file to ipfs
add <path> Add an object to ipfs
Copy link
Contributor

Choose a reason for hiding this comment

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

gotcha

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
need/review Needs a review topic/docs-ipfs Topic docs-ipfs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants