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

Refresh the README #34

Merged
merged 2 commits into from
Jun 16, 2019
Merged

Refresh the README #34

merged 2 commits into from
Jun 16, 2019

Conversation

kelset
Copy link
Member

@kelset kelset commented Jun 13, 2019

Summary

Now that we are sort of ready for v1, let's have a good README to pair with!

Next steps:

  1. Contributing as a separate file
    1A) Contributing guide should have a section on how to add comments (see Show comments in the diff #18)
  2. maybe add all-contributors?

@kelset kelset requested review from pvinis and lucasbento June 13, 2019 18:12
Copy link
Member

@lucasbento lucasbento 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 amazing, @kelset, thank you for working on this!

I just requested a few minor changes, aside from those this is definitely good to merge!


Runs the app in the development mode.<br>
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
![image](https://user-images.githubusercontent.com/6207220/59149165-90821780-8a12-11e9-97ef-d77c821f3bde.png)
Copy link
Member

Choose a reason for hiding this comment

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

This is ❤️

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
- a set of links with further explanations on what the version you are upgrading to
- an handy "done" button near each file to help you keep track of your process
- a download button for new binary files
- ...and we are planning many more features! Check the [enhacement tag](https://github.com/react-native-community/upgrade-helper/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Aenhancement) in the issue section.
Copy link
Member

Choose a reason for hiding this comment

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

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@lucasbento
Copy link
Member

lucasbento commented Jun 13, 2019

I would say the all-contributors is good, we can definitely add it afterwards!

Copy link
Member

@lucasbento lucasbento left a comment

Choose a reason for hiding this comment

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

Awesome!

Copy link
Member

@pvinis pvinis left a comment

Choose a reason for hiding this comment

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

super good

@pvinis pvinis merged commit 1ef3a8a into master Jun 16, 2019
@kelset kelset deleted the chore/add-readme branch June 17, 2019 09:25
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.

3 participants