Skip to content

chore(readme): modernize readme#3182

Merged
rwaskiewicz merged 9 commits intomainfrom
readme-update
Jan 4, 2022
Merged

chore(readme): modernize readme#3182
rwaskiewicz merged 9 commits intomainfrom
readme-update

Conversation

@rwaskiewicz
Copy link
Copy Markdown
Member

@rwaskiewicz rwaskiewicz 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
  • Unit tests (npm test) were run locally and passed
  • E2E Tests (npm run test.karma.prod) were run locally and passed
  • Prettier (npm run prettier) was run locally and passed

Pull request type

Please check the type of change your PR introduces:

  • Bugfix
  • Feature
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Documentation content changes
  • Other (please describe):

What is the current behavior?

Our README is a bit stale, full of information that should be modernized/fact checked
GitHub Issue Number: N/A

What is the new behavior?

Replicated 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

Does this introduce a breaking change?

  • Yes
  • No

Testing

The only tricky thing here is that the link to the logo assumes it's already checked into the repo, which it's obviously not at this time. That I couldn't test, but the path looks right to me.

Other information

@rwaskiewicz rwaskiewicz requested a review from a team December 10, 2021 21:08
@rwaskiewicz rwaskiewicz changed the title Readme update chore(readme): modernize readme Dec 10, 2021
@rwaskiewicz rwaskiewicz merged commit 5acb610 into main Jan 4, 2022
@rwaskiewicz rwaskiewicz deleted the readme-update branch January 4, 2022 15:04
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.

2 participants