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

update Readme file, add TOC, add badge #1769

Merged
merged 6 commits into from Mar 20, 2020
Merged

Conversation

@Simek
Copy link
Contributor

Simek commented Mar 18, 2020

This PR updates the README.md file. The goal was to use similar, coherent structure to the react-native repository Readme. The following changes has been made:

  • add Contents links at the top of file, just after description
  • add links to the prerequisite software (also I have bumped recommended Node version)

Question here: Can we bump it even to 12 for the website since next docs are recommending the latest LTS for RN?

  • utilize emojis in main headers (most of emojis was taken straight from react-native readme)
  • add license badge
  • use code formatting for the paths and files/folders names

Preview can be viewed here:

Simek added 2 commits Mar 18, 2020
@react-native-bot

This comment has been minimized.

Copy link

react-native-bot commented Mar 18, 2020

Deploy preview for react-native ready!

Built with commit 6389ff5

https://deploy-preview-1769--react-native.netlify.com

Changes to docs/ are reflected in the next "master" version.

Thank you for your contributions.

How to ContributeDocumentation Sources

Copy link
Contributor

rachelnabors left a comment

Looks good to me! Thanks for the helpful update!
kylo_thumbsup

@rachelnabors rachelnabors merged commit b861e50 into facebook:master Mar 20, 2020
3 checks passed
3 checks passed
ci/circleci: language_lint Your tests passed on CircleCI!
Details
ci/circleci: setup Your tests passed on CircleCI!
Details
ci/circleci: test Your tests passed on CircleCI!
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants
You can’t perform that action at this time.