Skip to content
This repository has been archived by the owner on Jun 4, 2021. It is now read-only.

Split README.md into smaller, easier-to-read pieces #1520

Merged

Conversation

nopdotcom
Copy link
Member

The existing README.md is intimidating, and doesn't immediately present the information that the reader wants first.

I couldn't resist rewriting a little, but the other sections are largely the same, and should be relatively easy to re-translate.

Copy link
Collaborator

@cpu cpu left a comment

Choose a reason for hiding this comment

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

This looks great @nopdotcom

Feel free to accept/reject my feedback as you feel appropriate. I'm 99.9% checked out of Streisand lately and just wanted to help see this PR get some traction because I definitely agree with you that it's needed 👍 Thanks for taking it on!

Installation.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
Services.md Outdated Show resolved Hide resolved
Services.md Outdated Show resolved Hide resolved
Services.md Outdated Show resolved Hide resolved
Services.md Outdated Show resolved Hide resolved
Services.md Outdated Show resolved Hide resolved
@nopdotcom nopdotcom requested a review from cpu March 12, 2019 16:58
Copy link
Collaborator

@cpu cpu left a comment

Choose a reason for hiding this comment

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

This is great, thanks @nopdotcom

@nopdotcom nopdotcom merged commit b667be2 into StreisandEffect:master Mar 12, 2019
martintsch pushed a commit to martintsch/streisand that referenced this pull request Apr 8, 2019
…1520)

* Split README.md into smaller, easier-to-read pieces

* Significant rewording, plus many useful suggestions from @cpu

* Reconcile differences of opinion on how Markdown should be rendered
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants