fix(readme): update readme to match new guidelines #3837
Conversation
|
PF3 preview: https://patternfly-react-pr-3837-pf3.surge.sh |
README.md
Outdated
| * TypeScript: [Fork and clone the PatternFly React Seed project](https://github.com/patternfly/patternfly-react-seed). | ||
| * JavaScript: [Fork and clone the JavaScript branch of the PatternFly React Seed project](https://github.com/patternfly/patternfly-react-seed/tree/javascript). | ||
|
|
||
| For more information about how to fork and clone a repo, [view GitHub Help](https://help.github.com/articles/fork-a-repo/). |
There was a problem hiding this comment.
Should this be indented? When I look at the rich text it is not aligned under the "1." I don't know if it should be.
There was a problem hiding this comment.
Updated alignment earlier.
| 2. **Install the project** | ||
|
|
||
| Follow the steps outlined in the [PatternFly React Seed README](https://github.com/patternfly/patternfly-react-seed#quick-start) to install. | ||
|
|
There was a problem hiding this comment.
Same question about alignment here.
There was a problem hiding this comment.
Updated alignment earlier.
Codecov Report
@@ Coverage Diff @@
## master #3837 +/- ##
=======================================
Coverage 71.01% 71.01%
=======================================
Files 785 785
Lines 10643 10643
Branches 2319 2319
=======================================
Hits 7558 7558
Misses 2655 2655
Partials 430 430
Continue to review full report at Codecov.
|
|
I added more spaces - see here: https://github.com/dgutride/patternfly-react/tree/update-readme |
Co-Authored-By: abigaeljamie <56559644+abigaeljamie@users.noreply.github.com>
dgutride
dismissed stale reviews from abigaeljamie, jessiehuff, and tlabaj
via
98ad075
Co-Authored-By: abigaeljamie <56559644+abigaeljamie@users.noreply.github.com>
6 participants
What: Closes #3753
Updates the parent readme for the project with new content