Skip to content

Commit 9e75cd4

Browse files
authored
Merge pull request #279 from patternfly/update-readme
Update README.md
2 parents 5647715 + f4f20b4 commit 9e75cd4

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
**[Getting Started][start] | [Element Catalog][storybook] | [Discovery doc](https://docs.google.com/document/d/1THnbwpUelkNfwHs8br-DmFYbJjX5NQwVveGYAP7XUAY/edit) | [Creating Components][develop] | [Theming Components][theming]**
22

3-
![PFElements logo](./brand/logo/png/rhelements-logo-red.png)
3+
<!-- ![PatternFly Elements logo](./brand/logo/png/rhelements-logo-red.png) -->
44

5-
[PFElements][rhe] is a collection of flexible and lightweight [Web Components][wc], and the tools to build them. PFElements are...
5+
[PatternFly Elements][pfe] is a collection of flexible and lightweight [Web Components][wc], and the tools to build them. PatternFly Elements are...
66

77
- **Lightweight**: small file size, minimal boilerplate, no "framework-like" features.
8-
- **Universal**: write once, use everywhere. PFElements work in React, Vue, Angular, vanilla JS, anywhere HTML elements are used.
8+
- **Universal**: write once, use everywhere. PatternFly Elements work in React, Vue, Angular, vanilla JS, anywhere HTML elements are used.
99

1010
The result of these two principles is plugging one set of comopnents into a wide variety of applications, bringing UX consistency and developer familiarity to any web project.
1111

@@ -15,23 +15,23 @@ Let's get started!
1515

1616
## Quick-start
1717

18-
git clone [email protected]:RHElements/rhelements.git
19-
cd rhelements
18+
git clone [email protected]:patternfly/patternfly-elements.git
19+
cd patternfly-elements
2020
npm install # this will take a while due to lerna bootstrap
21-
npm start
21+
npm run storybook
2222

23-
The `start` script will launch the demo pages. Demo pages are static showcases of each element, and also serve as scratchpads for experimenting while working on an element.
23+
The storybook script will launch the interactive demo pages.
2424

2525
_Notice: You will need to use [Node](https://nodejs.org/en/) v.7 or higher. Storybook *may* not work with Node v.10._
2626

2727
---
2828

2929
**[Getting Started][start] | [Developing Components][develop] | [Theming][theming]**
3030

31-
[rhe]: https://github.com/RHElements/rhelements
31+
[pfe]: https://github.com/patternfly/patternfly-elements
3232
[wc]: https://developer.mozilla.org/en-US/docs/Web/Web_Components
33-
[home]: https://rhelements.github.io/
33+
[home]: https://rhelements.github.io
3434
[start]: https://rhelements.github.io/getting-started/
3535
[develop]: https://rhelements.github.io/develop/
3636
[theming]: https://rhelements.github.io/theme/
37-
[storybook]: https://rhelements.github.io/rhelements/
37+
[storybook]: https://www.patternfly.org/patternfly-elements

0 commit comments

Comments
 (0)