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

Examples: stabalise README format and create-next-app usage #4009

Merged
merged 6 commits into from
Apr 3, 2018
Merged

Examples: stabalise README format and create-next-app usage #4009

merged 6 commits into from
Apr 3, 2018

Conversation

jthegedus
Copy link
Contributor

In the same vein as #4002

  • add create-next-app in example READMEs that were missing
  • add READMEs for examples without them
  • add yarn alternative instructions in each example's README - some examples were using yarn, others npm, this update just adds equal usage throughout the examples to be consistent.
  • add note to firebase-hosting example indicating to tag me in Firebase related issues.

note: if the yarn stuff is an issue, I can remove this pretty simply, although it's only a few extra lines and just makes it clear that most examples can be used with either package manager 🤷‍♀️

this sed command was used to mass-replace:

for d in *
do
    ( cd $d && sed -n -i '1h;1!H;${g;s/bash\nnpm install\nnpm run dev\n/bash\nnpm install\nnpm run dev\n# or\nyarn\nyarn dev\n/;p;}' README.md)
done

Copy link
Member

@timneutkens timneutkens 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 😌

@timneutkens timneutkens merged commit f2e5660 into vercel:canary Apr 3, 2018
@lock lock bot locked as resolved and limited conversation to collaborators Apr 3, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants