Skip to content

Commit ae21a66

Browse files
starryeyez024kylebuch8
authored andcommitted
Update README.md (#426)
* Update README.md Fix links in readme to point to https://patternfly.github.io/patternfly-elements/ * Update README.md fixed strange formatting of links; added logo * Update README.md remove gdoc * proposal for using reference links in README
1 parent 3796210 commit ae21a66

File tree

1 file changed

+25
-16
lines changed

1 file changed

+25
-16
lines changed

README.md

Lines changed: 25 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,23 @@
1-
**[Getting Started][start] | [Element Catalog][storybook] | [Discovery doc](https://docs.google.com/document/d/1THnbwpUelkNfwHs8br-DmFYbJjX5NQwVveGYAP7XUAY/edit) | [Creating Components][develop] | [Theming Components][theming]**
1+
<img src="https://www.patternfly.org/patternfly-elements/img/logo/svg/pfelements-icon-blue-shaded.svg" alt="PatternFly Elements logo" width=100px />
2+
3+
## Table of Contents
24

3-
<!-- ![PatternFly Elements logo](./brand/logo/png/rhelements-logo-red.png) -->
5+
1. [Getting started][getting-started]
6+
2. [Element catalog][catalog]
7+
3. [Creating components][creating]
8+
4. [Theming components][theming]
49

5-
[PatternFly Elements][pfe] is a collection of flexible and lightweight [Web Components][wc], and the tools to build them. PatternFly Elements are...
10+
[PatternFly Elements][pfe-home] is a collection of flexible and lightweight [Web Components][wc-org], and the tools to build them. PatternFly Elements are:
611

712
- **Lightweight**: small file size, minimal boilerplate, no "framework-like" features.
813
- **Universal**: write once, use everywhere. PatternFly Elements work in React, Vue, Angular, vanilla JS, anywhere HTML elements are used.
14+
- **Themable**: Make overrides as needed via attributes or CSS variables
915

10-
The result of these two principles is plugging one set of components into a wide variety of applications, bringing UX consistency and developer familiarity to any web project.
16+
The result of these principles is that you can plug one set of components into a wide variety of applications; bringing UX consistency and developer familiarity to any web project.
1117

1218
A Yeoman generator is included for creating Web Components that meets these goals.
1319

14-
Let's get started!
15-
16-
## Quick-start
20+
## Quick start
1721

1822
git clone [email protected]:patternfly/patternfly-elements.git
1923
cd patternfly-elements
@@ -22,16 +26,21 @@ Let's get started!
2226

2327
The storybook script will launch the interactive demo pages.
2428

25-
_Notice: You will need to use [Node](https://nodejs.org/en/) v.7 or higher. Storybook *may* not work with Node v.10._
29+
_Note: You will need to use [Node](https://nodejs.org/en/) v.7 or higher._
2630

2731
---
2832

29-
**[Getting Started][start] | [Developing Components][develop] | [Theming][theming]**
33+
[home][pfe-home] |
34+
[start][getting-started] |
35+
[develop][creating] |
36+
[theming][theming] |
37+
[storybook][catalog] |
38+
[web components][wc-org]
39+
3040

31-
[pfe]: https://github.com/patternfly/patternfly-elements
32-
[wc]: https://developer.mozilla.org/en-US/docs/Web/Web_Components
33-
[home]: https://rhelements.github.io
34-
[start]: https://rhelements.github.io/getting-started/
35-
[develop]: https://rhelements.github.io/develop/
36-
[theming]: https://rhelements.github.io/theme/
37-
[storybook]: https://www.patternfly.org/patternfly-elements
41+
[pfe-home]: https://patternfly.github.io/patternfly-elements
42+
[getting-started]: https://patternfly.github.io/patternfly-elements/getting-started
43+
[catalog]: https://patternfly.github.io/patternfly-elements/demo
44+
[creating]: https://patternfly.github.io/patternfly-elements/develop
45+
[theming]: https://patternfly.github.io/patternfly-elements/theme
46+
[wc-org]: https://webcomponents.org

0 commit comments

Comments
 (0)