Skip to content

Commit 46bffa9

Browse files
authored
Update README.md
1 parent 4354de9 commit 46bffa9

1 file changed

Lines changed: 9 additions & 4 deletions

File tree

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,20 @@
22

33
React components used inside of your web apps.
44

5-
## Component Development
5+
## Install
66

7-
To get started developing components first read [the storybook quickstart](https://storybook.js.org/basics/quick-start-guide/).
7+
```
8+
npm i @the-simple/web-components
9+
```
810

9-
Essentially all you need is to create your component and link it together with the current stories in `stories/index.stories.js`.
11+
```
12+
yarn add @the-simple/web-components
13+
```
1014

1115
## Automated Deployment
1216

13-
Deployment for the component library is an automated process requiring three separate tasks:
17+
Trigger by creating a new release version.
18+
The deployment for the component library is an automated process requiring three separate tasks:
1419

1520
- Testing: Building, linting, and unit testing code
1621
- Packaging: Deploying the npm package

0 commit comments

Comments
 (0)