Skip to content

chore(README): update readme format#24368

Merged
sean-perkins merged 5 commits intonextfrom
chore/update-readme
Dec 10, 2021
Merged

chore(README): update readme format#24368
sean-perkins merged 5 commits intonextfrom
chore/update-readme

Conversation

@sean-perkins
Copy link
Copy Markdown
Contributor

@sean-perkins sean-perkins commented Dec 10, 2021

Pull request checklist

Please check if your PR fulfills the following requirements:

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)
  • Build (npm run build) was run locally and any changes were pushed
  • Lint (npm run lint) has passed locally and any fixes were made for failures

Pull request type

Please check the type of change your PR introduces:

  • Bugfix
  • Feature
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Documentation content changes
  • Other (please describe):

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Preview Changes

Introduce branding and content changes to the README.

  • Adds migration guides section
  • Adds download metrics for independent packages
  • Adds community links (discord, forums, twitter)

Does this introduce a breaking change?

  • Yes
  • No

Other information

Need to update the link for v6 migration to latest once /next docs are merged into main (FW-416).

@sean-perkins sean-perkins requested a review from a team December 10, 2021 17:34
Copy link
Copy Markdown
Contributor

@averyjohnston averyjohnston 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! Just noticed a couple minor things. I love the new branding at the top.

Copy link
Copy Markdown
Contributor

@averyjohnston averyjohnston left a comment

Choose a reason for hiding this comment

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

Good to go once the logo is updated 👍

Copy link
Copy Markdown
Contributor

@liamdebeasi liamdebeasi left a comment

Choose a reason for hiding this comment

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

Good to go once logo is updated as well. Great work!

@sean-perkins sean-perkins merged commit 3fc278a into next Dec 10, 2021
@sean-perkins sean-perkins deleted the chore/update-readme branch December 10, 2021 22:00
rwaskiewicz added a commit to stenciljs/core that referenced this pull request Jan 4, 2022
Replicate some of the work (read: a lot) of the work done in ionic-team/ionic-framework#24368. Highlights include:
- adding the Stencil logo
- adding quick links to things like documentation, the community
- removing redundant/out of date information
- removing data that can be found in the Stencil docs
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