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

Update readme.md #427

Merged
merged 1 commit into from Jul 2, 2018

Conversation

Projects
None yet
2 participants
@detrohutt
Collaborator

detrohutt commented Jul 1, 2018

These are things I thought would improve users' usage and comprehension of the project.
Feel free to make any changes or throw it out altogether.

You can see the result in markdown at my fork's master branch

  • Minor elaborations
  • Add a notice about the new labels and link to the issue requesting help organizing them
  • Inline email link instead of directing readers to the link at the bottom
  • Point "watching the repo" link to a page that lets readers watch the repo
  • Add a disclaimer about questions that may not be answered (by you or otherwise)
  • Add a disclaimer about audio and video answers, linking to the corresponding labels
  • Add section header for alternate contact mediums for better separation from disclaimer
Update readme.md
These are things I thought would improve users' usage and comprehension of the project.
Feel free to make any changes or throw it out altogether.

* Minor elaborations
* Add a notice about the new labels and link to the issue requesting help organizing them
* Inline email link instead of directing readers to the link at the bottom
* Point "watching the repo" link to a page that lets readers watch the repo
* Add a disclaimer about questions that may not be answered (by you or otherwise)
* Add a disclaimer about audio and video answers, linking to the corresponding labels
* Add section header for alternate contact mediums for better separation from disclaimer

@detrohutt detrohutt requested a review from kentcdodds Jul 1, 2018

@detrohutt

This comment has been minimized.

Show comment
Hide comment
@detrohutt

detrohutt Jul 1, 2018

Collaborator

In hindsight I should've made these separate commits for easier review and let you squash them. I'll do that in the future.

Collaborator

detrohutt commented Jul 1, 2018

In hindsight I should've made these separate commits for easier review and let you squash them. I'll do that in the future.

@kentcdodds

This is great! Thank you!

@kentcdodds kentcdodds merged commit fdea3a5 into kentcdodds:master Jul 2, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment